The SDL Component Suite is an industry leading collection of components supporting scientific and engineering computing. Please visit the SDL Web site for more information....


Home BasePack FileSys Procedures Registry GetRegValueAsBoolean
See also: GetRegValue, GetRegValueAsInt, GetRegValueAsDouble 

GetRegValueAsBoolean

Unit: SDL_filesys
Class: none
Declaration: function GetRegValueAsBoolean (RootKey: HKEY; SubKey, ValueID: string): boolean;

The function GetRegValueAsBoolean reads a value of the Windows registry and interprets and returns it as a boolean value. The parameter RootKey defines the root key and can take one of the following values: HKEY_CURRENT_USER, HKEY_LOCAL_MACHINE, HKEY_USERS, HKEY_PERFORMANCE_DATA, HKEY_CURRENT_CONFIG and HKEY_DYN_DATA. The parameter SubKey specifies the key (including its path) used within the branch of the root key and the parameter ValueID specifies the value to be retrieved.

The function returns the registry value always as a boolean value, no matter in which format the value is stored. If the type of the stored value is unknown, non-existant or not supported then the function returns a FALSE value. If the value is a string containing the word "TRUE" the function returns a TRUE value, in any other case it returns a FALSE value (however, the values are not case-sensitive).


Last Update: 2023-Feb-06