Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


Methods of Class RegistryKey


RegistryKey
RegistryKey();

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

Summary
Default constructor

RegistryKey
RegistryKey(
const RegistryKey & toCopy );

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

Summary
Copy constructor

~RegistryKey
~RegistryKey();

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

Summary
Destructor, close the key if it references an open one.

operator=
RegistryKey & operator=(
const RegistryKey & toAssign );

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

Summary
Assign operator

isValid
sal_Bool isValid();

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

Summary
checks if the key points to a valid registry key.

isReadOnly
sal_Bool isReadOnly();

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

Summary
returns the access mode of the key.
Return
TRUE if access mode is read only else FALSE.

getName
::rtl::OUString getName();

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

Summary
returns the full qualified name of the key beginning with the rootkey.

createKey
RegError createKey(
const ::rtl::OUString & keyName,
RegistryKey & rNewKey );

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

Summary
creates a new key or opens a key if the specified key already exists.
Description
The specified keyname is relativ to this key.
Parameters
keyName
specifies the name of the key which will be opened or created.
rNewKey
references a RegistryKey which will be filled with the new or open key. 
Return
REG_NO_ERROR if succeeds else an error code.

openKey
RegError openKey(
const ::rtl::OUString & keyName,
RegistryKey & rOpenKey );

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

Summary
opens the specified key.
Description
The specified keyname is relativ to this key.
Parameters
keyName
specifies the name of the key which will be opened.
rOpenKey
references a RegistryKey which will be filled with the open key.
Return
REG_NO_ERROR if succeeds else an error code.

openSubKeys
RegError openSubKeys(
const ::rtl::OUString & keyName,
RegistryKeyArray & rSubKeys );

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

Summary
opens all subkeys of the specified key.
Description
The specified keyname is relativ to this key.
Parameters
keyName
specifies the name of the key which subkeys will be opened.
rSubKeys
reference a RegistryKeyArray which will be filled with the open subkeys.
Return
REG_NO_ERROR if succeeds else an error code.

getKeyNames
RegError getKeyNames(
const ::rtl::OUString & keyName,
RegistryKeyNames & rSubKeyNames );

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

Summary
returns an array with the names of all subkeys of the specified key.
Description
The specified keyname is relativ to this key.
Parameters
keyName
specifies the name of the key which subkey names will be returned.
rSubKeyNames
reference a RegistryKeyNames array which will be filled with the subkey names.
Return
REG_NO_ERROR if succeeds else an error code.

closeSubKeys
RegError closeSubKeys(
RegistryKeyArray & rSubKeys );

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

Summary
closes all keys specified in the array.
Parameters
rSubKeys
reference a RegistryKeyArray which contains the open keys.
Return
REG_NO_ERROR if succeeds else an error code.

deleteKey
RegError deleteKey(
const ::rtl::OUString & keyName );

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

Summary
deletes the specified key.
Parameters
keyName
specifies the name of the key which will be deleted.
Return
REG_NO_ERROR if succeeds else an error code.

closeKey
RegError closeKey();

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

Summary
closes explicitly the current key

releaseKey
void releaseKey();

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

Summary
releases the current key

setValue
RegError setValue(
const ::rtl::OUString & keyName,
RegValueType valueType,
RegValue pValue,
sal_uInt32 valueSize );

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

Summary
sets a value of a key.
Parameters
keyName
specifies the name of the key which value will be set. 
                If keyName is an empty string, the value will be set for the key 
                specified by hKey.
valueType
specifies the type of the value.
pData
points to a memory block containing the data for the value.
valueSize
specifies the size of pData in bytes
Return
REG_NO_ERROR if succeeds else an error code.

setLongListValue
RegError setLongListValue(
const ::rtl::OUString & keyName,
sal_Int32 * pValueList,
sal_uInt32 len );

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

Summary
sets a long list value of a key.
Parameters
keyName
specifies the name of the key which value will be set. 
                If keyName is an empty string, the value will be set for the key 
                specified by hKey.
pValueList
points to an array of longs containing the data for the value.
len
specifies the length of the list (the array referenced by pValueList).
Return
REG_NO_ERROR if succeeds else an error code.

setStringListValue
RegError setStringListValue(
const ::rtl::OUString & keyName,
sal_Char * * pValueList,
sal_uInt32 len );

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

Summary
sets an ascii list value of a key.
Parameters
keyName
specifies the name of the key which value will be set. 
                If keyName is an empty string, the value will be set for the key 
                specified by hKey.
pValueList
points to an array of sal_Char* containing the data for the value.
len
specifies the length of the list (the array referenced by pValueList).
Return
REG_NO_ERROR if succeeds else an error code.

setUnicodeListValue
RegError setUnicodeListValue(
const ::rtl::OUString & keyName,
sal_Unicode * * pValueList,
sal_uInt32 len );

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

Summary
sets an unicode string list value of a key.
Parameters
keyName
specifies the name of the key which value will be set. 
                If keyName is an empty string, the value will be set for the key 
                specified by hKey.
pValueList
points to an array of sal_Unicode* containing the data for the value.
len
specifies the length of the list (the array referenced by pValueList).
Return
REG_NO_ERROR if succeeds else an error code.

getValueInfo
RegError getValueInfo(
const ::rtl::OUString & keyName,
RegValueType * pValueType,
sal_uInt32 * pValueSize );

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

Summary
gets info about type and size of a value.
Parameters
keyName
specifies the name of the key which value info will be returned. 
                If keyName is an empty string, the value info of the key 
                specified by hKey will be returned.
pValueType
returns the type of the value.
pValueSize
returns the size of the value in bytes or the length of a list value.
Return
REG_NO_ERROR if succeeds else an error code.

getValue
RegError getValue(
const ::rtl::OUString & keyName,
RegValue pValue );

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

Summary
gets the value of a key.
Parameters
keyName
specifies the name of the key which value will be returned. 
                If keyName is an empty string, the value is get from the key 
                specified by hKey.
pValue
points to an allocated memory block receiving the data of the value. 
Return
REG_NO_ERROR if succeeds else an error code.

getLongListValue
RegError getLongListValue(
const ::rtl::OUString & keyName,
RegistryValueList< sal_Int32 > & rValueList );

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

Summary
gets a long list value of a key.
Parameters
keyName
specifies the name of the key which value will be returned. 
                If keyName is an empty string, the value is get from the key 
                specified by hKey.
rValueList
references a RegistryValueList which will be filled with the long values.
Return
REG_NO_ERROR if succeeds else an error code.

getStringListValue
RegError getStringListValue(
const ::rtl::OUString & keyName,
RegistryValueList< sal_Char * > & rValueList );

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

Summary
gets an ascii list value of a key.
Parameters
keyName
specifies the name of the key which value will be returned. 
                If keyName is an empty string, the value is get from the key 
                specified by hKey.
rValueList
references a RegistryValueList which will be filled with the ascii values.
Return
REG_NO_ERROR if succeeds else an error code.

getUnicodeListValue
RegError getUnicodeListValue(
const ::rtl::OUString & keyName,
RegistryValueList< sal_Unicode * > & rValueList );

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

Summary
gets a unicode value of a key.
Parameters
keyName
specifies the name of the key which value will be returned. 
                        If keyName is an empty string, the value is get from the key 
                        specified by hKey.
        
rValueList
reference a RegistryValueList which will be filled with the unicode values.
        
Return
REG_NO_ERROR if succeeds else an error code.

createLink
RegError createLink(
const ::rtl::OUString & linkName,
const ::rtl::OUString & linkTarget );

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

D E P R E C A T E D
Summary
used to create a link.
Description
Links are no longer supported.
Return
REG_INVALID_LINK

deleteLink
RegError deleteLink(
const ::rtl::OUString & linkName );

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

D E P R E C A T E D
Summary
used to delete a link.
Description
Links are no longer supported.
Return
REG_INVALID_LINK

getKeyType
RegError getKeyType(
const ::rtl::OUString & name,
RegKeyType * pKeyType ) const;

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

Summary
returns the type of the specified key.
Parameters
name
specifies the name of the key or link.
pKeyType
returns the type of the key (always RG_KEYTYPE).
Return
REG_NO_ERROR if succeeds else an error code.

getLinkTarget
RegError getLinkTarget(
const ::rtl::OUString & linkName,
::rtl::OUString & rLinkTarget ) const;

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

D E P R E C A T E D
Summary
used to return the target of a link.
Description
Links are no longer supported.
Return
REG_INVALID_LINK

getResolvedKeyName
RegError getResolvedKeyName(
const ::rtl::OUString & keyName,
sal_Bool firstLinkOnly,
::rtl::OUString & rResolvedName ) const;

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

Summary
resolves a keyname.
Parameters
keyName
specifies the name of the key which will be resolved relativ to this key.
                        The resolved name will be prefixed with the name of this key.
        
firstLinkOnly
ignored
        
Return
REG_NO_ERROR if succeeds else an error code.

getRegistryName
::rtl::OUString getRegistryName();

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

Summary
returns the name of the registry in which the key is defined.

getRegistry
Registry getRegistry();

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

Summary
returns the registry in which the key is defined.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.