Overview | Namespace | Class | Index | Help

PUBLIC MEMBERS: | CLASSES | STRUCTS | UNIONS | ENUMS | TYPEDEFS | METHODS | STATIC METHODS | DATA | STATIC DATA
PROTECTED MEMBERS: | CLASSES | STRUCTS | UNIONS | ENUMS | TYPEDEFS | METHODS | STATIC METHODS | DATA | STATIC DATA

::

## class Registry

Base Classes
  None.

Known Derived Classes
  None.

virtual | abstract | interface | template
NO | NO | NO | NO

Summary
  The Registry provides the functionality to read and write information in a registry file.
Description
  The class is implemented inline and use a load on call C-Api.

File
  registry.hxx

### Public Members

  #### Methods
  Registry( const Registry_Api * pApi ); | Constructor using the registry Api directly.
  Registry( const RegistryLoader & rLoader ); | Constructor using the loader mechanism.
  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.
  ::rtl::OUString getName( ); | returns the name of the current registry data file.
  RegError create( const ::rtl::OUString & registryName ); | creates a new registry with the specified name and creates a root key.
  RegError open( const ::rtl::OUString & registryName, RegAccessMode accessMode ); | opens a registry with the specified name.
  RegError close( ); | closes explicitly the current registry data file.
  RegError destroy( const ::rtl::OUString & registryName ); | destroys a registry.
  RegError loadKey( RegistryKey & rKey, const ::rtl::OUString & keyName, const ::rtl::OUString & regFileName ); | 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 & regFileName ); | 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 & regFileName, 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 Members

  #### Data
  const Registry_Api * m_pApi; | stores the used and initialized registry Api.
  ::salhelper::ODynamicLoader< Registry_Api > m_Api; | stores the dynamic loader which is used to hold the library.
  RegHandle m_hImpl; | stores the handle of the underlying registry file on which most of the functions work.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.