RegistryConfigurationReader Class Reference

A class that supports reading configuration maps from the registry on Windows. More...

List of all members.

Public Member Functions

void LoadConfiguration (ConfigMap &io_configMap, const simba_wstring &in_path, const simba_wstring &in_name, const simba_wstring *in_sectionFilter=NULL)
 Loads a configuration map from the registry (Windows).
void LoadConfiguration (SectionConfigMap &io_configMap, const simba_wstring &in_path, const simba_wstring &in_name, const simba_wstring *in_sectionFilter=NULL, bool in_returnDriver=false)
 Loads a configuration map from the registry (Windows).
 RegistryConfigurationReader (bool in_caseSensitiveKeys=true)
 Constructor.
virtual ~RegistryConfigurationReader ()
 Destructor.

Detailed Description

A class that supports reading configuration maps from the registry on Windows.

IMPORTANT NOTE: Do not use this class on Linux/OSX/Unix as its implementation is not included in the SDK libraries on these platforms.


Constructor & Destructor Documentation

RegistryConfigurationReader ( bool  in_caseSensitiveKeys = true  ) 

Constructor.

Parameters:
in_caseSensitiveKeys Should key names be case sensitive (default is true). If false, all configuration key names will be converted to uppercase. Section names are always converted to uppercase despite this.
virtual ~RegistryConfigurationReader (  )  [virtual]

Destructor.


Member Function Documentation

void LoadConfiguration ( ConfigMap io_configMap,
const simba_wstring in_path,
const simba_wstring in_name,
const simba_wstring in_sectionFilter = NULL 
)

Loads a configuration map from the registry (Windows).

Two levels of configuration are loaded.

Parameters:
io_configMap Configuration map to fill. Structure: io_configMap[SectionName][KeyName] = KeyValue Section names are converted to uppercase. Key names are case sensitive.
in_path Root path to look for the configuration in. If the configuration is not found there, the defaults will be searched. Use an empty string to skip this step. + accepted values: "HKEY_CURRENT_USER", "HKEY_LOCAL_MACHINE" + search order: + in_path\in_name, + HKEY_CURRENT_USER\in_name, + HKEY_LOCAL_MACHINE\in_name
in_name Name of the file/registry key to open under HKCU or HKLM.
in_sectionFilter Restrict reading of the config to only one particular section. Pass NULL for no filter. Pass an empty string to filter for keys that are not in a subsection. Only reads keys from the in_sectionFilter subkey beneath the in_name key.
void LoadConfiguration ( SectionConfigMap io_configMap,
const simba_wstring in_path,
const simba_wstring in_name,
const simba_wstring in_sectionFilter = NULL,
bool  in_returnDriver = false 
)

Loads a configuration map from the registry (Windows).

Only one level of configuration is loaded: The base section if in_sectionFilter is NULL, or a specific subsection if in_sectionFilter is specified.

Parameters:
io_configMap Configuration map to fill.

  • Structure: io_configMap[KeyName] = KeyValue
  • Keys names are case sensitive.
in_path Root path to look for the configuration in. If the configuration is not found there, the defaults will be searched. Use an empty string to skip this step. + accepted values: "HKEY_CURRENT_USER", "HKEY_LOCAL_MACHINE" + search order: + in_path\in_name, + HKEY_CURRENT_USER\in_name, + HKEY_LOCAL_MACHINE\in_name
in_name Name of the registry key to open under HKCU or HKLM
in_sectionFilter Restrict reading of the config to only one particular section. Pass NULL for no filter. Pass an empty string to filter for keys that are not in a subsection. Only reads keys from the in_sectionFilter subkey beneath the in_name key.
in_returnDriver Flag to indicate that DRIVER keyword should be returned.

The documentation for this class was generated from the following file:

Generated on Wed May 17 14:21:19 2017 for SimbaEngine 10.1.3.1011 by simba