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
)

Parameter Name	Description
strSettingPath	Indicates the path of the setting.
nIdx	Indicates the index.

Returns the value of the setting.

Exceptions

Exception	Description
BaseException	Thrown if the setting is not defined.
System.ArgumentNullException	Thrown when `strSettingPath` is `null`.
System.ArgumentException	Thrown when `strSettingPath` is empty.
System.ArgumentException	Thrown when setting path dosn't exist.