Global Functions in Namespace in Sourcefile registry.h

reg_closeKey

extern "C"
RegError reg_closeKey(

hKey );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function closes the specified key.

Parameters

hKey	identifies a currently open key which will be closed by this function. The memory of the variable specifying the key will be freed.

Return

REG_NO_ERROR if succeeds else an error code.

reg_closeRegistry

extern "C"
RegError reg_closeRegistry(

RegHandle

hRegistry );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function closes a registry.

Parameters

hRegistry

identifies a currently open registry which should be closed.

Return

REG_NO_ERROR if succeeds else an error code.

reg_closeSubKeys

extern "C"
RegError reg_closeSubKeys(

RegKeyHandle *	phSubKeys,
sal_uInt32	nSubKeys );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function closes all subkeys specified in the array.

Parameters

phSubKeys

points to a variable that containss an array of all opened subkeys. 
                  The allocated memory of pphSubKeys and all open subkeys will be freed.

nSubKeys

specifies the length of the array (the number of subkeys to closed).

Return

REG_NO_ERROR if succeeds else an error code.

reg_createKey

extern "C"
RegError reg_createKey(

RegKeyHandle	hKey,
rtl_uString *	keyName,
RegKeyHandle *	phNewKey );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function creates the specified key.

Description

If the key already exists in the registry, the function opens the key only.

Parameters

hKey

identifies a currently open key. The key which will be opened or created by this
                 function is a subkey of the key identified by hKey.

keyName

points to a null terminated string specifying the name of a key.

phNewKey

points to a variable that receives the handle of the opened or created 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.

Return

REG_NO_ERROR if succeeds else an error code.

reg_createLink

extern "C"
RegError reg_createLink(

RegKeyHandle	hKey,
rtl_uString *	linkName,
rtl_uString *	linkTarget );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function creates a link with the specified link name and link target.

Description

Links in the registry are similar to links in the UNIX fielsystem. If a link will be opened, the link target will be resolved and the key speciefied by the link target will be opened.

Parameters

hKey

identifies a currently open key. The link which will be created is a subkey
             of the key identified by hKey.

linkName

points to a null terminated string specifying the name of the new link.

linkTarget

points to a null terminated string specifying the link target of the new link.
                   The linktarget must specify a valid name of an existing key. The linktarget itself
                   can contain links in the full qualified name. All links will be resolved if the
                   link will be opened.

Return

REG_NO_ERROR if succeeds else an error code.

reg_createRegistry

extern "C"
RegError reg_createRegistry(

rtl_uString *	registryName,
RegHandle *	phRegistry );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function creates a new registry with the specified name and creates a root key.

Parameters

registryName	points to a null terminated string specifying the name of the new registry.
phRegistry	points to a handle of the new registry if the function succeeds otherwise NULL.

Return

REG_NO_ERROR if succeeds else an error code.

reg_deleteKey

extern "C"
RegError reg_deleteKey(

RegKeyHandle	hKey,
rtl_uString *	keyName );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function deletes the specified key.

Parameters

hKey	identifies a currently open key. The key deleted by this function is a subkey of the key identified by hKey
keyName	points to a null terminated string specifying the name of a key which will be deleted.

Return

REG_NO_ERROR if succeeds else an error code.

reg_deleteLink

extern "C"
RegError reg_deleteLink(

RegKeyHandle	hKey,
rtl_uString *	linkName );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function deletes a link with the specified linkname.

Parameters

hKey	identifies a currently open key. The link which will be deleted is a subkey of the key identified by hKey.
linkName	points to a null terminated string specifying the name of the link.

Return

REG_NO_ERROR if succeeds else an error code.

reg_destroyRegistry

extern "C"
RegError reg_destroyRegistry(

RegHandle	hRegistry,
rtl_uString *	registryName );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function destroys a registry.

Parameters

hRegistry	identifies a currently open registry.
registryName	specifies a registry name of a registry which should be destroyed. If the name is NULL the registry itselfs will be destroyed.

Return

REG_NO_ERROR if succeeds else an error code.

reg_dumpRegistry

extern "C"
RegError reg_dumpRegistry(

RegKeyHandle

hKey );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function reports the complete registry information of a key and all of its subkeys.

Description

All information which are available (keynames, value types, values, linknames, linktargets, ...) will be printed to stdout for report issues only.

Parameters

hKey	identifies a currently open key which content will be reported.

Return

REG_NO_ERROR if succeeds else an error code.

reg_freeValueList

extern "C"
RegError reg_freeValueList(

RegValueType	valueType,
RegValue	pValueList,
sal_uInt32	len );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function frees the memory of a value list.

Parameters

valueType	specifies the type of the list values.
pValueList	a Pointer to the value list.
len	specifies the length of the value list.

Return

REG_NO_ERROR if succeeds else an error code.

reg_getKeyName

extern "C"
const RegError reg_getKeyName(

RegKeyHandle	hKey,
rtl_uString * *	pKeyName );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function returns the name of a key.

Parameters

hKey	identifies a currently open key which name will be returned.
pKeyName	contains the keyname if succeeds else an empty string.

reg_getKeyType

extern "C"
RegError reg_getKeyType(

RegKeyHandle	hKey,
rtl_uString *	keyName,
RegKeyType *	pKeyType );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function returns the type of a key.

Description

The registry differentiates two possible types: - RG_KEYTYPE represents a real key - RG_LINKTYPE represents a link

Parameters

keyName	points to a null terminated string specifying the name of the key which keytype will be returned.
pKeyType	returns the type of the key.

Return

REG_NO_ERROR if succeeds else an error code.

reg_getLinkTarget

extern "C"
RegError reg_getLinkTarget(

RegKeyHandle	hKey,
rtl_uString *	linkName,
rtl_uString * *	pLinkTarget );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function returns the linktarget of a link.

Parameters

linkName	points to a null terminated string specifying the name of the link which linktarget will be returned.
pLinkTarget	contains the linktarget if succeeds else an empty string.

Return

REG_NO_ERROR if succeeds else an error code.

reg_getLongListValue

extern "C"
RegError reg_getLongListValue(

RegKeyHandle	hKey,
rtl_uString *	keyName,
sal_Int32 * *	pValueList,
sal_uInt32 *	pLen );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function gets the long list value of a key.

Parameters

keyName

points to a null terminated string specifying the name of a key which value
                will be got. If keyName is NULL, then the value of the key specified by
                hKey will be got.

pValueList

a Pointer to a long value list which returns the data of the value.

pLen

returns the length of the value list.

Return

REG_NO_ERROR if succeeds else an error code.

reg_getName

extern "C"
const RegError reg_getName(

RegHandle	hRegistry,
rtl_uString * *	pName );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function returns the name of a registry.

Parameters

hReg	identifies a currently open registry whose name will be returned.
pName	returns the name of the registry if the function succeeds otherwise an empty string.

Return

REG_NO_ERROR if succeeds else an error code.

reg_getResolvedKeyName

extern "C"
RegError reg_getResolvedKeyName(

RegKeyHandle	hKey,
rtl_uString *	keyName,
sal_Bool	firstLinkOnly,
rtl_uString * *	pResolvedName );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function resolves all or only the first link of a keyname.

Description

and returns the resolved keyName in pResolvedName.

Parameters

hKey

identifies a currently open key. The key specified by keyName is a subkey
             of the key identified by hKey.

keyName

points to a null terminated string specifying the relativ name of a key.
                The name of hKey together with keyName will be resolved from links.

Return

REG_NO_ERROR if succeeds else an error code.

reg_getStringListValue

extern "C"
RegError reg_getStringListValue(

RegKeyHandle	hKey,
rtl_uString *	keyName,
sal_Char * * *	pValueList,
sal_uInt32 *	pLen );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function gets the string list value of a key.

Parameters

keyName

points to a null terminated string specifying the name of a key which value
                will be got. If keyName is NULL, then the value of the key specified by
                hKey will be got.

pValueList

a Pointer to an ascii value list which returns the data of the value.

pLen

returns the length of the value list.

Return

REG_NO_ERROR if succeeds else an error code.

reg_getUnicodeListValue

extern "C"
RegError reg_getUnicodeListValue(

RegKeyHandle	hKey,
rtl_uString *	keyName,
sal_Unicode * * *	pValueList,
sal_uInt32 *	pLen );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function gets the unicode list value of a key.

Parameters

keyName

points to a null terminated string specifying the name of a key which value
                will be got. If keyName is NULL, then the value of the key specified by
                hKey will be got.

pValueList

a Pointer to an unicode value list which returns the data of the value.

pLen

returns the length of the value list.

Return

REG_NO_ERROR if succeeds else an error code.

reg_getValue

extern "C"
RegError reg_getValue(

RegKeyHandle	hKey,
rtl_uString *	keyName,
RegValue	pData );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function gets the value of a key.

Parameters

hKey

identifies a currently open key. The key which value will be got by this
             function is a subkey of the key identified by hKey.

keyName

points to a null terminated string specifying the name of a key which value
                will be got. If keyName is NULL, then the value of the key specified by
                hKey will be got.

pData

points to an allocated memory block receiving the data of the value.

Return

REG_NO_ERROR if succeeds else an error code.

reg_getValueInfo

extern "C"
RegError reg_getValueInfo(

RegKeyHandle	hKey,
rtl_uString *	keyName,
RegValueType *	pValueType,
sal_uInt32 *	pValueSize );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function gets info about type and size of a key value.

Parameters

hKey	identifies a currently open key. The key which value info will be got by this function is a subkey of the key identified by hKey.
keyName	points to a null terminated string specifying the name of a key which value will be got. If keyName is NULL, then the value info of the key specified by hKey will be got.
pValueType	returns the type of the value.
pValueSize	returns the size of the value in bytes

Return

REG_NO_ERROR if succeeds else an error code.

reg_isReadOnly

extern "C"
sal_Bool reg_isReadOnly(

RegHandle

hReg );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function returns the access mode of the registry.

Parameters

hReg	identifies a currently open registry.

Return

TRUE if accessmode is read only else FALSE.

reg_loadKey

extern "C"
RegError reg_loadKey(

RegKeyHandle	hKey,
rtl_uString *	keyName,
rtl_uString *	regFileName );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function loads registry information from a file and save it under the specified keyName.

Parameters

hKey

identifies a currently open key. The key which should store the registry information
             is a subkey of this key.

keyName

points to a null terminated string specifying the name of the key which stores the
                registry information. If keyName is NULL the registry information will be saved under
                the key specified by hKey.

regFileName

points to a null terminated string specifying the file which conains the 
                    registry information.

Return

REG_NO_ERROR if succeeds else an error code.

reg_mergeKey

extern "C"
RegError reg_mergeKey(

RegKeyHandle	hKey,
rtl_uString *	keyName,
rtl_uString *	regFileName,
sal_Bool	bWarnings,
sal_Bool	bReport );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function merges the registry information from a specified source with the information of the currently open registry.

Description

All existing keys will be extended and existing key values will be overwritten.

Parameters

hKey	identifies a currently open key. The key which information is merged by this function is a subkey of the key identified by hKey.
keyName	points to a null terminated string specifying the name of the key which will be merged. If keyName is NULL the registry information under the key specified by hKey is merged with the complete information from the specified file.
regFileName	points to a null terminated string specifying 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.

Return

REG_NO_ERROR if succeeds else an error code.

reg_openKey

extern "C"
RegError reg_openKey(

RegKeyHandle	hKey,
rtl_uString *	keyName,
RegKeyHandle *	phOpenKey );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function opens the specified key.

Parameters

hKey

identifies a currently open key. The key which will be opened by this function 
             is a subkey of the key identified by hKey

keyName

points to a null terminated string specifying the name of a key.

phNewKey

points 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.

Return

REG_NO_ERROR if succeeds else an error code.

reg_openRegistry

extern "C"
RegError reg_openRegistry(

rtl_uString *	registryName,
RegHandle *	phRegistry,
RegAccessMode	accessMode );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function opens a registry with the specified name.

Parameters

registryName

points to a null terminated string specifying the name of the registry.

phRegistry

points to a hanle of the opened registry if the function succeeds otherwise NULL.

accessMode

specifies the accessmode of the registry, REG_READONLY or REG_READWRITE.

Return

REG_NO_ERROR if succeeds else an error code.

reg_openRootKey

extern "C"
RegError reg_openRootKey(

RegHandle	hRegistry,
RegKeyHandle *	phRootKey );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function opens the root key of a registry.

Parameters

hReg	identifies a currently open registry whose rootKey will be returned.
phRootKey	points to a handle of the open root key if the function succeeds otherwise NULL.

Return

REG_NO_ERROR if succeeds else an error code.

reg_openSubKeys

extern "C"
RegError reg_openSubKeys(

RegKeyHandle	hKey,
rtl_uString *	keyName,
RegKeyHandle * *	pphSubKeys,
sal_uInt32 *	pnSubKeys );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function opens all subkeys of the specified key.

Parameters

hKey	identifies a currently open key. The key that subkeys will be opened by this function is a subkey of the key identified by hKey
keyName	points to a null terminated string specifying the name of a key whose subkeys will be opened.
pphSubKeys	points to a variable that receives an array of all opened subkeys. The memory to store this variable will be allocated and will be freed by the function reg_closeSubKeys. If the function fails, pphSubKeys is NULL.
pnSubKeys	specifies the length of the array (the number of open subkeys).

Return

REG_NO_ERROR if succeeds else an error code.

reg_saveKey

extern "C"
RegError reg_saveKey(

RegKeyHandle	hKey,
rtl_uString *	keyName,
rtl_uString *	regFileName );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function saves the registry information under a specified key and all of its subkeys and save it in a registry file.

Parameters

hKey

identifies a currently open key. The key which information is saved by this
             function is a subkey of the key identified by hKey.

keyName

points to a null terminated string specifying the name of the subkey.
                If keyName is NULL the registry information under the key specified by hKey
                will be saved in the specified file.

regFileName

points to a null terminated string specifying the file which will contain the 
                    registry information.

Return

REG_NO_ERROR if succeeds else an error code.

reg_setLongListValue

extern "C"
RegError reg_setLongListValue(

RegKeyHandle	hKey,
rtl_uString *	keyName,
sal_Int32 *	pValueList,
sal_uInt32	len );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function sets an long list value of a key.

Parameters

keyName

points to a null terminated string specifying the name of a key which value
                will be set. If keyName is NULL, then the value of the key specified by
                hKey will be set.

pValueList

points to an array of longs containing the data of the value.

len

specifies the len of pValueList.

Return

REG_NO_ERROR if succeeds else an error code.

reg_setStringListValue

extern "C"
RegError reg_setStringListValue(

RegKeyHandle	hKey,
rtl_uString *	keyName,
sal_Char * *	pValueList,
sal_uInt32	len );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function sets an ascii list value of a key.

Parameters

keyName

points to a null terminated string specifying the name of a key which value
                will be set. If keyName is NULL, then the value of the key specified by
                hKey will be set.

pValueList

points to an array of sal_Char* containing the data of the value.

len

specifies the len of pValueList.

Return

REG_NO_ERROR if succeeds else an error code.

reg_setUnicodeListValue

extern "C"
RegError reg_setUnicodeListValue(

RegKeyHandle	hKey,
rtl_uString *	keyName,
sal_Unicode * *	pValueList,
sal_uInt32	len );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function sets an unicode string list value of a key.

Parameters

keyName

points to a null terminated string specifying the name of a key which value
                will be set. If keyName is NULL, then the value of the key specified by
                hKey will be set.

pValueList

points to an array of sal_Unicode* containing the data of the value.

len

specifies the len of pValueList.

Return

REG_NO_ERROR if succeeds else an error code.

reg_setValue

extern "C"
RegError reg_setValue(

RegKeyHandle	hKey,
rtl_uString *	keyName,
RegValueType	valueType,
RegValue	pData,
sal_uInt32	valueSize );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

This function sets a value of a key.

Parameters

hKey	identifies a currently open key. The key which value will be set by this function is a subkey of the key identified by hKey.
keyName	points to a null terminated string specifying the name of a key which value will be set. If keyName is NULL, then the value of the key specified by hKey will be set.
valueType	specifies the type of the value.
pData	points to a memory block containing the data of the value.
valueSize	specifies the size of pData in bytes

Return

REG_NO_ERROR if succeeds else an error code.

Global Functions in Global Namespace C++ in Sourcefile registry.h

Global Functions in Global Namespace C++
in Sourcefile registry.h