My Project
UDK 3.2.7 C/C++ API Reference
|
The Registry provides the functionality to read and write information in a registry file. More...
#include <registry.hxx>
Public Member Functions | |
Registry () | |
Default constructor. | |
Registry (const Registry &toCopy) | |
Copy constructcor. | |
~Registry () | |
Destructor. The Destructor close the registry if it is open. | |
Registry & | operator= (const Registry &toAssign) |
Assign operator. | |
sal_Bool | isValid () const |
checks if the registry points to a valid registry data file. | |
sal_Bool | isReadOnly () const |
returns the access mode of the registry. | |
RegError | openRootKey (RegistryKey &rRootKey) |
opens the root key of the registry. | |
inline::rtl::OUString | getName () |
returns the name of the current registry data file. | |
RegError | create (const ::rtl::OUString ®istryName) |
creates a new registry with the specified name and creates a root key. | |
RegError | open (const ::rtl::OUString ®istryName, RegAccessMode accessMode) |
opens a registry with the specified name. | |
RegError | close () |
closes explicitly the current registry data file. | |
RegError | destroy (const ::rtl::OUString ®istryName) |
destroys a registry. | |
RegError | loadKey (RegistryKey &rKey, const ::rtl::OUString &keyName, const ::rtl::OUString ®FileName) |
loads registry information from a specified file and save it under the specified keyName. | |
RegError | saveKey (RegistryKey &rKey, const ::rtl::OUString &keyName, const ::rtl::OUString ®FileName) |
saves the registry information of the specified key and all subkeys and save it in the specified file. | |
RegError | mergeKey (RegistryKey &rKey, const ::rtl::OUString &keyName, const ::rtl::OUString ®FileName, sal_Bool bWarnings=sal_False, sal_Bool bReport=sal_False) |
merges the registry information of the specified key with the registry information of the specified file. | |
RegError | dumpRegistry (RegistryKey &rKey) |
This function reports the complete registry information of a key and all of its subkeys. | |
const Registry_Api * | getApi () |
returns the used registry Api. |
Protected Attributes | |
const Registry_Api * | m_pApi |
stores the used and initialized registry Api. | |
RegHandle | m_hImpl |
stores the handle of the underlying registry file on which most of the functions work. |
Friends | |
class | RegistryKey |
class | RegistryKeyArray |
class | RegistryKeyNames |
The Registry provides the functionality to read and write information in a registry file.
The class is implemented inline and use a C-Api.
|
inline |
Default constructor.
|
inline |
Copy constructcor.
|
inline |
Destructor. The Destructor close the registry if it is open.
|
inline |
closes explicitly the current registry data file.
|
inline |
creates a new registry with the specified name and creates a root key.
registryName | specifies the name of the new registry. |
|
inline |
destroys a registry.
registryName | specifies a registry name, if the name is an empty string the registry itselfs will be destroyed. |
|
inline |
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.
rKey | references a currently open key which content will be reported. |
|
inline |
returns the used registry Api.
|
inline |
returns the name of the current registry data file.
|
inline |
returns the access mode of the registry.
|
inline |
checks if the registry points to a valid registry data file.
|
inline |
loads registry information from a specified file and save it under the specified keyName.
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. |
|
inline |
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.
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. |
|
inline |
opens a registry with the specified name.
If the registry already points to a valid registry, the old registry will be closed.
registryName | specifies a registry name. |
accessMode | specifies the access mode for the registry, REG_READONLY or REG_READWRITE. |
|
inline |
opens the root key of the registry.
rRootKey | reference to a RegistryKey which is filled with the rootkey. |
|
inline |
saves the registry information of the specified key and all subkeys and save it in the specified file.
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. |
|
friend |
|
friend |
|
friend |
|
protected |
stores the handle of the underlying registry file on which most of the functions work.
|
protected |
stores the used and initialized registry Api.