Registry Class Reference
The Registry provides the functionality to read and write information in a registry file.
More...
#include <registry.hxx>
List of all members.
Detailed Description
The Registry provides the functionality to read and write information in a registry file.
The class is implemented inline and use a C-Api.
Constructor & Destructor Documentation
Registry::Registry |
( |
|
) |
[inline] |
Registry::Registry |
( |
const Registry & |
toCopy |
) |
[inline] |
Registry::~Registry |
( |
|
) |
[inline] |
Destructor. The Destructor close the registry if it is open.
Member Function Documentation
RegError Registry::close |
( |
void |
|
) |
[inline] |
closes explicitly the current registry data file.
creates a new registry with the specified name and creates a root key.
- Parameters:
-
| registryName | specifies the name of the new registry. |
- Returns:
- REG_NO_ERROR if succeeds else an error code.
destroys a registry.
- Parameters:
-
| registryName | specifies a registry name, if the name is an empty string the registry itselfs will be destroyed. |
- Returns:
- REG_NO_ERROR if succeeds else an error code.
This function reports the complete registry information of a key and all of its subkeys.
All information which are available (keynames, value types, values, ...) will be printed to stdout for report issues only.
- Parameters:
-
| rKey | references a currently open key which content will be reported. |
- Returns:
- REG_NO_ERROR if succeeds else an error code.
returns the used registry Api.
returns the name of the current registry data file.
sal_Bool Registry::isReadOnly |
( |
|
) |
const [inline] |
returns the access mode of the registry.
- Returns:
- TRUE if the access mode is readonly else FALSE.
sal_Bool Registry::isValid |
( |
void |
|
) |
const [inline] |
checks if the registry points to a valid registry data file.
loads registry information from a specified file and save it under the specified keyName.
- Parameters:
-
| rKey | references a currently open key. The key which should store the registry information is a subkey of this key. |
| keyName | specifies the name of the key which stores the registry information. If keyName is is an empty string the registry information will be saved under the key specified by rKey. |
| regFileName | specifies the file containing the registry information. |
- Returns:
- REG_NO_ERROR if succeeds else an error code.
merges the registry information of the specified key with the registry information of the specified file.
All existing keys will be extended and existing key values will be overwritten.
- Parameters:
-
| rKey | references a currently open key. The key which information is merged by this function is a subkey of this key |
| keyName | specifies the name of the key which will be merged. If keyName is an empty string the registry information under the key specified by rKey is merged with the information from the specified file. |
| regFileName | specifies the file containing the registry information. |
| bWarnings | if TRUE the function returns an error if a key already exists. |
| bReport | if TRUE the function reports warnings on stdout if a key already exists. |
- Returns:
- REG_NO_ERROR if succeeds else an error code. If it returns an error the registry will restore the state before merging.
opens a registry with the specified name.
If the registry already points to a valid registry, the old registry will be closed.
- Parameters:
-
| registryName | specifies a registry name. |
| accessMode | specifies the access mode for the registry, REG_READONLY or REG_READWRITE. |
- Returns:
- REG_NO_ERROR if succeeds else an error code.
opens the root key of the registry.
- Parameters:
-
| rRootKey | reference to a RegistryKey which is filled with the rootkey. |
- Returns:
- REG_NO_ERROR if succeeds else an error code.
saves the registry information of the specified key and all subkeys and save it in the specified file.
- Parameters:
-
| rKey | references a currently open key. The key which information is saved by this function is a subkey of this key. |
| keyName | specifies the name of the key which information should be stored. If keyName is an empty string the registry information under the key specified by rKey is saved in the specified file. |
| regFileName | specifies the file containing the registry information. |
- Returns:
- REG_NO_ERROR if succeeds else an error code.
Friends And Related Function Documentation
Member Data Documentation
stores the handle of the underlying registry file on which most of the functions work.
stores the used and initialized registry Api.
The documentation for this class was generated from the following file: