API Help
Eplan.EplApi.Base Namespace / Settings Class / GetBoolSetting Method
Indicates the path of the setting.
Indicates the index.

In This Topic
    GetBoolSetting Method (Settings)
    In This Topic
    Returns the value of a setting. If a setting is read that has no value for this index, the default value is returned. The index starts at 0.
    Syntax
    public virtual bool GetBoolSetting( 
       string strSettingPath,
       int nIdx
    )
    public:
    virtual bool GetBoolSetting( 
       String^ strSettingPath,
       int nIdx
    ) 

    Parameters

    strSettingPath
    Indicates the path of the setting.
    nIdx
    Indicates the index.

    Return Value

    Returns the value of the setting.
    Exceptions
    ExceptionDescription
    The setting is not defined.
    Thrown when strSettingPath is null.
    Thrown when strSettingPath is empty.
    Thrown when setting path dosn't exist.
    See Also