RegistryKeyArray Class Reference

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

#include <registry.hxx>

Collaboration diagram for RegistryKeyArray:

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

Private 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...
RegKeyHandle *	m_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 175 of file registry.hxx.

Constructor & Destructor Documentation

RegistryKeyArray()

RegistryKeyArray::RegistryKeyArray ( )

inline

Default constructor.

Definition at line 553 of file registry.hxx.

~RegistryKeyArray()

RegistryKeyArray::~RegistryKeyArray ( )

inline

Destructor, all subkeys will be closed.

Definition at line 559 of file registry.hxx.

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

Member Function Documentation

getElement()

RegistryKey RegistryKeyArray::getElement ( sal_uInt32  index )

inline

returns the open key specified by index.

Definition at line 565 of file registry.hxx.

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

getLength()

sal_uInt32 RegistryKeyArray::getLength ( ) const

inline

returns the length of the array.

Definition at line 573 of file registry.hxx.

References m_length.

setKeyHandles()

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

inlineprivate

sets the data of the key array.

Parameters

registry	specifies the registry files where the keys are located.
phKeys	points to an array of open keys.
length	specifies the length of the array specified by phKeys.

Definition at line 578 of file registry.hxx.

References length, m_length, m_phKeys, and m_registry.

Referenced by RegistryKey::openSubKeys().

Friends And Related Function Documentation

RegistryKey

friend class RegistryKey

friend

Definition at line 190 of file registry.hxx.

Referenced by getElement().

Member Data Documentation

m_length

sal_uInt32 RegistryKeyArray::m_length

private

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

Definition at line 202 of file registry.hxx.

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

m_phKeys

RegKeyHandle* RegistryKeyArray::m_phKeys

private

stores an array of open subkeys.

Definition at line 204 of file registry.hxx.

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

m_registry

Registry RegistryKeyArray::m_registry

private

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

Definition at line 206 of file registry.hxx.

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

---

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

• registry.hxx