Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.10

API

SDK

Tips ‘n’ Tricks

Miscellaneous


::

class RegistryKey


Base Classes
None.
Known Derived Classes
None.

virtual abstract interface template
NO NO NO NO
Summary
RegistryKey reads or writes information of the underlying key in a registry.
Description
Class is inline and use a load on call C-Api.
File
registry.hxx

Public Members

Methods


RegistryKey( );
Default constructor

RegistryKey( const RegistryKey & toCopy );
Copy constructor

~RegistryKey( );
Destructor, close the key if it references an open one.
RegistryKey &
operator=( const RegistryKey & toAssign );
Assign operator
sal_Bool
isValid( ) const;
checks if the key points to a valid registry key.
sal_Bool
isReadOnly( ) const;
returns the access mode of the key.
::rtl::OUString
getName( );
returns the full qualified name of the key beginning with the rootkey.
RegError
createKey( const ::rtl::OUString & keyName, RegistryKey & rNewKey );
creates a new key or opens a key if the specified key already exists.
RegError
openKey( const ::rtl::OUString & keyName, RegistryKey & rOpenKey );
opens the specified key.
RegError
openSubKeys( const ::rtl::OUString & keyName, RegistryKeyArray & rSubKeys );
opens all subkeys of the specified key.
RegError
getKeyNames( const ::rtl::OUString & keyName, RegistryKeyNames & rSubKeyNames );
returns an array with the names of all subkeys of the specified key.
RegError
closeSubKeys( RegistryKeyArray & rSubKeys );
closes all keys specified in the array.
RegError
deleteKey( const ::rtl::OUString & keyName );
deletes the specified key.
RegError
closeKey( );
closes explicitly the current key
void
releaseKey( );
releases the current key
RegError
setValue( const ::rtl::OUString & keyName, RegValueType valueType, RegValue pValue, sal_uInt32 valueSize );
sets a value of a key.
RegError
setLongListValue( const ::rtl::OUString & keyName, sal_Int32 * pValueList, sal_uInt32 len );
sets a long list value of a key.
RegError
setStringListValue( const ::rtl::OUString & keyName, sal_Char * * pValueList, sal_uInt32 len );
sets an ascii list value of a key.
RegError
setUnicodeListValue( const ::rtl::OUString & keyName, sal_Unicode * * pValueList, sal_uInt32 len );
sets an unicode string list value of a key.
RegError
getValueInfo( const ::rtl::OUString & keyName, RegValueType * pValueType, sal_uInt32 * pValueSize );
gets info about type and size of a value.
RegError
getValue( const ::rtl::OUString & keyName, RegValue pValue );
gets the value of a key.
RegError
getLongListValue( const ::rtl::OUString & keyName, RegistryValueList< sal_Int32 > & rValueList );
gets a long list value of a key.
RegError
getStringListValue( const ::rtl::OUString & keyName, RegistryValueList< sal_Char * > & rValueList );
gets an ascii list value of a key.
RegError
getUnicodeListValue( const ::rtl::OUString & keyName, RegistryValueList< sal_Unicode * > & rValueList );
gets a unicode value of a key.
RegError
createLink( const ::rtl::OUString & linkName, const ::rtl::OUString & linkTarget );
used to create a link.
RegError
deleteLink( const ::rtl::OUString & linkName );
used to delete a link.
RegError
getKeyType( const ::rtl::OUString & name, RegKeyType * pKeyType ) const;
returns the type of the specified key.
RegError
getLinkTarget( const ::rtl::OUString & linkName, ::rtl::OUString & rLinkTarget ) const;
used to return the target of a link.
RegError
getResolvedKeyName( const ::rtl::OUString & keyName, sal_Bool firstLinkOnly, ::rtl::OUString & rResolvedName ) const;
resolves a keyname.
::rtl::OUString
getRegistryName( );
returns the name of the registry in which the key is defined.
Registry
getRegistry( ) const;
returns the registry in which the key is defined.

Protected Members

Data

Registry m_registry; stores the registry on which this key works
RegKeyHandle m_hImpl; stores the current key handle of this key

Top of Page

Apache Software Foundation

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

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