INIFile: GetBoolean

GetBoolean

Returns a Boolean value from the specified key in the specified section of an INI file.



 Public Function GetBoolean(
	  ByVal Section As String,
	  ByVal Key As String,
	  Optional ByVal Default As Boolean ) As Boolean

Parameters

Section
[ByVal] String. The section within the INI file to search for the key.
Key
[ByVal] String. The key in the section of an INI file to retrieve the value of.
Default
[ByVal] Optional. Boolean. The default value to return if the key is not found in the section, or the value could not be converted to a Boolean.

Return Values

Boolean - 

Remarks

An INI file contains all values as Strings. The value is converted back into a Boolean using the CBool function. If an error happens, then the default is returned.

See Also

Project VBCorLib Overview Class INIFile Overview INIFile Properties INIFile Methods Flush GetByte