UDK 3.2.7 C/C++ API Reference
Public Member Functions | Protected Member Functions | Protected Attributes | Friends
RegistryKeyArray Class Reference

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

#include <registry.hxx>

List of all members.

Public Member Functions

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

Protected Member Functions

void setKeyHandles (Registry &registry, RegKeyHandle *phKeys, sal_uInt32 length)
 sets the data of the key array.
RegError closeKeyHandles ()
 close all subkeys

Protected Attributes

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

Friends

class RegistryKey

Detailed Description

RegistryKeyArray represents an array of open keys.

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


Constructor & Destructor Documentation

RegistryKeyArray::RegistryKeyArray ( ) [inline]

Default constructor.

RegistryKeyArray::~RegistryKeyArray ( ) [inline]

Destructor, all subkeys will be closed.


Member Function Documentation

RegError RegistryKeyArray::closeKeyHandles ( ) [inline, protected]

close all subkeys

RegistryKey RegistryKeyArray::getElement ( sal_uInt32  index) [inline]

returns the open key specified by index.

sal_uInt32 RegistryKeyArray::getLength ( ) [inline]

returns the length of the array.

void RegistryKeyArray::setKeyHandles ( Registry registry,
RegKeyHandle phKeys,
sal_uInt32  length 
) [inline, protected]

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.

Friends And Related Function Documentation

friend class RegistryKey [friend]

Member Data Documentation

sal_uInt32 RegistryKeyArray::m_length [protected]

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

stores an array of open subkeys.

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


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines