---

basic_reg_key Class Template Reference
[Registry Library]

Represents a registry key. More...

#include <winstl_reg_key.h>

List of all members.

Public Types
typedef C	char_type
	The character type.
typedef T	traits_type
	The traits type.
typedef A	allocator_type
	The allocator type.
typedef basic_reg_key< C, T, A >	class_type
	The current parameterisation of the type.
typedef traits_type::size_type	size_type
	The size type.
typedef traits_type::string_type	string_type
	The string type.
typedef traits_type::hkey_type	hkey_type
	The key type.
Public Methods
	basic_reg_key ()
	Default constructor.
	basic_reg_key (hkey_type hkeyParent, string_type const &key_name, REGSAM samDesired=KEY_READ)
	Construct from the named sub-key of the given parent.
	basic_reg_key (class_type const &keyParent, string_type const &key_name, REGSAM samDesired=KEY_READ)
	Construct from the named sub-key of the given parent.
	basic_reg_key (class_type const &rhs)
	Copy constructor.
	basic_reg_key (class_type const &rhs, REGSAM samDesired)
	Copy constructor.
	~basic_reg_key () winstl_throw_0()
	Destructor.
class_type &	operator= (class_type const &rhs)
	Copy assignment operator.
string_type const &	name () const
	The name of the key.
string_type	reg_class () const
	The registry class of the key.
ws_uint_t	num_sub_keys () const
	The number of sub-keys.
ws_uint_t	num_values () const
	The number of values.
hkey_type	get_key_handle () const
	The key handle.
class_type	open_sub_key (char_type const *sub_key_name, REGSAM samDesired=KEY_READ)
	Opens the named sub-key of this key.
class_type	create_sub_key (char_type const *sub_key_name, REGSAM samDesired=KEY_READ)
	Creates a named sub-key of this key.

---

Detailed Description

template<typename C, typename T = reg_traits<C>, typename A = processheap_allocator<C>>
class winstl::basic_reg_key< C, T, A >

Represents a registry key.

This class acts as the value type of classes that manipulate registry keys and encapsulates the concept of a registry key.

Parameters:

C	The character type
T	The traits type. On translators that support default template arguments this defaults to reg_traits<C>
A	The allocator type. On translators that support default template arguments this defaults to processheap_allocator<C>

---

Member Typedef Documentation

typedef A allocator_type

The allocator type.

typedef C char_type

The character type.

typedef basic_reg_key<C, T, A> class_type

The current parameterisation of the type.

typedef traits_type::hkey_type hkey_type

The key type.

typedef traits_type::size_type size_type

The size type.

typedef traits_type::string_type string_type

The string type.

typedef T traits_type

The traits type.

---

Constructor & Destructor Documentation

basic_reg_key (    )

Default constructor.

basic_reg_key (  hkey_type    hkeyParent, string_type const &    key_name, REGSAM    samDesired = KEY_READ )  [inline]

Construct from the named sub-key of the given parent.

basic_reg_key (  class_type const &    keyParent, string_type const &    key_name, REGSAM    samDesired = KEY_READ )  [inline]

Construct from the named sub-key of the given parent.

basic_reg_key (  class_type const &    rhs )

Copy constructor.

basic_reg_key (  class_type const &    rhs, REGSAM    samDesired )

Copy constructor. Parameters: rhs  The key from which to copy samDesired  a change of permissions

~basic_reg_key (    )

Destructor.

---

Member Function Documentation

class_type create_sub_key (  char_type const *    sub_key_name, REGSAM    samDesired = KEY_READ )

Creates a named sub-key of this key.

hkey_type get_key_handle (    )

The key handle.

string_type const& name (    )

The name of the key.

ws_uint_t num_sub_keys (    )

The number of sub-keys.

ws_uint_t num_values (    )

The number of values.

class_type open_sub_key (  char_type const *    sub_key_name, REGSAM    samDesired = KEY_READ )

Opens the named sub-key of this key.

class_type& operator= (  class_type const &    rhs )

Copy assignment operator.

string_type reg_class (    )

The registry class of the key.

---

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

• winstl_reg_key.h

STLSoft Libraries documentation © Synesis Software Pty Ltd, 2001-2004