LibreOffice Module registry (master)  1
Public Member Functions | Protected Member Functions | Private Attributes | Friends | List of all members
RegistryKeyArray Class Reference

RegistryKeyArray represents an array of open keys. More...

#include <registry.hxx>

Collaboration diagram for RegistryKeyArray:
[legend]

Public Member Functions

 RegistryKeyArray ()
 Default constructor. More...
 
 ~RegistryKeyArray ()
 Destructor, all subkeys will be closed. More...
 
RegistryKey getElement (sal_uInt32 index)
 returns the open key specified by index. More...
 
sal_uInt32 getLength () const
 returns the length of the array. More...
 

Protected Member Functions

void setKeyHandles (Registry const &registry, RegKeyHandle *phKeys, sal_uInt32 length)
 sets the data of the key array. More...
 

Private Attributes

sal_uInt32 m_length
 stores the number of open subkeys, the number of elements. More...
 
RegKeyHandlem_phKeys
 stores an array of open subkeys. More...
 
Registry m_registry
 stores the handle to the registry file where the appropriate keys are located. More...
 

Friends

class RegistryKey
 

Detailed Description

RegistryKeyArray represents an array of open keys.

RegistryKeyArray is a helper class to work with an array of keys.

Definition at line 195 of file registry.hxx.

Constructor & Destructor Documentation

RegistryKeyArray::RegistryKeyArray ( )
inline

Default constructor.

Definition at line 574 of file registry.hxx.

RegistryKeyArray::~RegistryKeyArray ( )
inline

Destructor, all subkeys will be closed.

Definition at line 580 of file registry.hxx.

References m_length, Registry::m_pApi, m_phKeys, and m_registry.

Member Function Documentation

RegistryKey RegistryKeyArray::getElement ( sal_uInt32  index)
inline

returns the open key specified by index.

Definition at line 586 of file registry.hxx.

References Registry::isValid(), m_length, m_phKeys, m_registry, and RegistryKey.

sal_uInt32 RegistryKeyArray::getLength ( ) const
inline

returns the length of the array.

Definition at line 594 of file registry.hxx.

References m_length.

void RegistryKeyArray::setKeyHandles ( Registry const &  registry,
RegKeyHandle phKeys,
sal_uInt32  length 
)
inlineprotected

sets the data of the key array.

Parameters
registryspecifies the registry files where the keys are located.
phKeyspoints to an array of open keys.
lengthspecifies the length of the array specified by phKeys.

Definition at line 599 of file registry.hxx.

References m_length, m_phKeys, and m_registry.

Referenced by RegistryKey::openSubKeys().

Friends And Related Function Documentation

friend class RegistryKey
friend

Definition at line 210 of file registry.hxx.

Referenced by getElement().

Member Data Documentation

sal_uInt32 RegistryKeyArray::m_length
private

stores the number of open subkeys, the number of elements.

Definition at line 221 of file registry.hxx.

Referenced by getElement(), getLength(), setKeyHandles(), and ~RegistryKeyArray().

RegKeyHandle* RegistryKeyArray::m_phKeys
private

stores an array of open subkeys.

Definition at line 223 of file registry.hxx.

Referenced by getElement(), setKeyHandles(), and ~RegistryKeyArray().

Registry RegistryKeyArray::m_registry
private

stores the handle to the registry file where the appropriate keys are located.

Definition at line 225 of file registry.hxx.

Referenced by getElement(), setKeyHandles(), and ~RegistryKeyArray().


The documentation for this class was generated from the following file: