LibreOffice Module registry (master)  1
Functions
regapi.hxx File Reference
#include <rtl/ustring.h>
#include <registry/regtype.h>
#include <registry/regdllapi.h>
Include dependency graph for regapi.hxx:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openKey (RegKeyHandle hKey, rtl_uString *keyName, RegKeyHandle *phOpenKey)
 This function opens the specified key. More...
 
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_closeKey (RegKeyHandle hKey)
 This function closes the specified key. More...
 
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openRootKey (RegHandle hRegistry, RegKeyHandle *phRootKey)
 This function opens the root key of a registry. More...
 
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openRegistry (rtl_uString *registryName, RegHandle *phRegistry)
 This function opens a registry with the specified name. More...
 
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_closeRegistry (RegHandle hRegistry)
 This function closes a registry. More...
 
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_dumpRegistry (RegKeyHandle hKey)
 This function reports the complete registry information of a key and all of its subkeys. More...
 

Function Documentation

This function closes the specified key.

Parameters
hKeyidentifies a currently open key which will be closed by this function. The memory of the variable specifying the key will be freed.
Returns
REG_NO_ERROR if succeeds else an error code.

Definition at line 685 of file regkey.cxx.

References closeKey(), and INVALID_KEY.

REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_closeRegistry ( RegHandle  hRegistry)

This function closes a registry.

Parameters
hRegistryidentifies a currently open registry which should be closed.
Returns
REG_NO_ERROR if succeeds else an error code.

Definition at line 368 of file registry.cxx.

References NO_ERROR, and REGISTRY_NOT_OPEN.

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
hKeyidentifies a currently open key which content will be reported.
Returns
REG_NO_ERROR if succeeds else an error code.

Definition at line 384 of file registry.cxx.

References dumpRegistry(), ORegKey::getRegistry(), and INVALID_KEY.

REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openKey ( RegKeyHandle  hKey,
rtl_uString *  keyName,
RegKeyHandle phOpenKey 
)

This function opens the specified key.

Parameters
hKeyidentifies a currently open key. The key which will be opened by this function is a subkey of the key identified by hKey
keyNamepoints to a null terminated string specifying the name of a key.
phOpenKeypoints to a variable that receives the handle of the opened key. The memory to store this variable will be allocated and will be freed by the function reg_closeKey. If the function fails, phNewKey is NULL.
Returns
REG_NO_ERROR if succeeds else an error code.

Definition at line 672 of file regkey.cxx.

References INVALID_KEY, and openKey().

REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openRegistry ( rtl_uString *  registryName,
RegHandle phRegistry 
)

This function opens a registry with the specified name.

in readonly mode.

Parameters
registryNamepoints to a null terminated string specifying the name of the registry.
phRegistrypoints to a handle of the opened registry if the function succeeds otherwise NULL.
Returns
REG_NO_ERROR if succeeds else an error code.

Definition at line 347 of file registry.cxx.

References ORegistry::initRegistry(), NO_ERROR, READONLY, and RegError.

REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openRootKey ( RegHandle  hRegistry,
RegKeyHandle phRootKey 
)

This function opens the root key of a registry.

Parameters
hRegistryidentifies a currently open registry whose rootKey will be returned.
phRootKeypoints to a handle of the open root key if the function succeeds otherwise NULL.
Returns
REG_NO_ERROR if succeeds else an error code.

Definition at line 338 of file registry.cxx.

References openRootKey().