PLCore::RegistryImpl Class Reference

Abstract base class for platform specific 'Registry' implementations. More...

#include <RegistryImpl.h>

Inheritance diagram for PLCore::RegistryImpl:

List of all members.

Protected Member Functions
	RegistryImpl ()
	Constructor.
virtual	~RegistryImpl ()
	Destructor.
virtual uint32	GetRegistryType () const =0
	Get type of registry.
virtual bool	Open (uint32 nKey, const String &sSubKey, uint32 nAccess)=0
	Open registry key.
virtual bool	Create (uint32 nKey, const String &sSubKey, uint32 nAccess)=0
	Create a new registry key.
virtual bool	Delete ()=0
	Delete the registry key.
virtual void	Close ()=0
	Close registry key.
virtual uint32	GetOpenKey () const =0
	Get ID of opened registry key.
virtual String	GetOpenSubKey () const =0
	Get name of opened sub-key.
virtual uint32	GetOpenAccessMode () const =0
	Get access mode.
virtual uint32	GetNumOfSubKeys () const =0
	Returns the number of sub-keys.
virtual String	GetSubKey (uint32 nIndex) const =0
	Get a sub-key of the opened registry key.
virtual uint32	GetNumOfValues () const =0
	Returns the number of values.
virtual String	GetValue (uint32 nIndex) const =0
	Get a value of the opened registry key.
virtual uint32	GetValueType (const String &sName) const =0
	Get the type of a given value.
virtual String	GetValueString (const String &sName) const =0
	Get a value of type string.
virtual uint32	GetValueDWord (const String &sName) const =0
	Get a value of type 'dword'.
virtual uint32	GetValueBinary (const String &sName, uint8 *pBuffer, uint32 nSize) const =0
	Get a value of type binary.
virtual bool	SetValueString (const String &sName, const String &sValue)=0
	Set a value of type string.
virtual bool	SetValueDWord (const String &sName, uint32 nValue)=0
	Set a value of type 'dword'.
virtual bool	SetValueBinary (const String &sName, const uint8 *pBuffer, uint32 nSize)=0
	Set a value of type binary.
virtual void	Flush ()=0
	Write all values to the registry.

---

Detailed Description

Abstract base class for platform specific 'Registry' implementations.

---

Constructor & Destructor Documentation

PLCore::RegistryImpl::RegistryImpl

(

)

[protected]

Constructor.

virtual PLCore::RegistryImpl::~RegistryImpl

(

)

[protected, virtual]

Destructor.

---

Member Function Documentation

virtual uint32 PLCore::RegistryImpl::GetRegistryType

(

)

const [protected, pure virtual]

Get type of registry.

Returns:

Type of registry ('RegistryNone' if no registry is available on your system!) (type: "Registry::ERegistry")

virtual bool PLCore::RegistryImpl::Open	(	uint32	nKey,
		const String &	sSubKey,
		uint32	nAccess
	)		[protected, pure virtual]

Open registry key.

Parameters:

[in]	nKey	Registry key (type: "Registry::EKey")
[in]	sSubKey	Name of subkey
[in]	nAccess	Access modes (combination of 'EAccess' values)

Returns:

'true' if all went fine, else 'false'

virtual bool PLCore::RegistryImpl::Create	(	uint32	nKey,
		const String &	sSubKey,
		uint32	nAccess
	)		[protected, pure virtual]

Create a new registry key.

Parameters:

[in]	nKey	Registry key (type: "Registry::EKey")
[in]	sSubKey	Name of subkey
[in]	nAccess	Access modes (combination of 'EAccess' values)

Returns:

'true' if all went fine, else 'false'

virtual bool PLCore::RegistryImpl::Delete

(

)

[protected, pure virtual]

Delete the registry key.

Returns:

'true' if all went fine, else 'false'

virtual void PLCore::RegistryImpl::Close

(

)

[protected, pure virtual]

Close registry key.

virtual uint32 PLCore::RegistryImpl::GetOpenKey

(

)

const [protected, pure virtual]

Get ID of opened registry key.

Returns:

Key ID (type: "Registry::EKey")

virtual String PLCore::RegistryImpl::GetOpenSubKey

(

)

const [protected, pure virtual]

Get name of opened sub-key.

Returns:

Name of sub-key

virtual uint32 PLCore::RegistryImpl::GetOpenAccessMode

(

)

const [protected, pure virtual]

Get access mode.

Returns:

Access mode

virtual uint32 PLCore::RegistryImpl::GetNumOfSubKeys

(

)

const [protected, pure virtual]

Returns the number of sub-keys.

Returns:

Number of sub-keys

virtual String PLCore::RegistryImpl::GetSubKey

(

uint32

nIndex

)

const [protected, pure virtual]

Get a sub-key of the opened registry key.

Parameters:

[in]

nIndex

Index of the sub-key

Returns:

Name of the sub-key, or "" if no more sub-keys are present

virtual uint32 PLCore::RegistryImpl::GetNumOfValues

(

)

const [protected, pure virtual]

Returns the number of values.

Returns:

Number of values

virtual String PLCore::RegistryImpl::GetValue

(

uint32

nIndex

)

const [protected, pure virtual]

Get a value of the opened registry key.

Parameters:

[in]

nIndex

Index of the value

Returns:

Name of the value, or "" if no more values are present

virtual uint32 PLCore::RegistryImpl::GetValueType

(

const String &

sName

)

const [protected, pure virtual]

Get the type of a given value.

Parameters:

[in]

sName

Name of the value

Returns:

Type of the value (type: "Registry::EType")

virtual String PLCore::RegistryImpl::GetValueString

(

const String &

sName

)

const [protected, pure virtual]

Get a value of type string.

Parameters:

[in]

sName

Name of the value

Returns:

String value

virtual uint32 PLCore::RegistryImpl::GetValueDWord

(

const String &

sName

)

const [protected, pure virtual]

Get a value of type 'dword'.

Parameters:

[in]

sName

Name of the value

Returns:

Value

virtual uint32 PLCore::RegistryImpl::GetValueBinary	(	const String &	sName,
		uint8 *	pBuffer,
		uint32	nSize
	)		const [protected, pure virtual]

Get a value of type binary.

Parameters:

[in]	sName	Name of the value
[out]	pBuffer	Buffer to receive the value, if a null pointer, returns the number of bytes required
[in]	nSize	Size of the given buffer in bytes, ignored if 'pBuffer' is a null pointer

Returns:

Number of bytes written to the buffer

virtual bool PLCore::RegistryImpl::SetValueString	(	const String &	sName,
		const String &	sValue
	)		[protected, pure virtual]

Set a value of type string.

Parameters:

[in]	sName	Name of the value
[in]	sValue	String value to set

Returns:

'true' if all went fine, else 'false'

virtual bool PLCore::RegistryImpl::SetValueDWord	(	const String &	sName,
		uint32	nValue
	)		[protected, pure virtual]

Set a value of type 'dword'.

Parameters:

[in]	sName	Name of the value
[in]	nValue	Value to set

Returns:

'true' if all went fine, else 'false'

virtual bool PLCore::RegistryImpl::SetValueBinary	(	const String &	sName,
		const uint8 *	pBuffer,
		uint32	nSize
	)		[protected, pure virtual]

Set a value of type binary.

Parameters:

[in]	sName	Name of the value
[in]	pBuffer	Buffer containing the value to set (if a null pointer, the function fails)
[in]	nSize	Size of the given buffer in bytes

Returns:

'true' if all went fine, else 'false'

virtual void PLCore::RegistryImpl::Flush

(

)

[protected, pure virtual]

Write all values to the registry.

---

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

• RegistryImpl.h