basic_reg_value Class Template Reference
[Windows Registry Library]

#include <winstl/registry/reg_value.hpp>

List of all members.

---

Detailed Description

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

Represents a registry value, providing methods for accessing the value in different types.

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

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>

Examples:

by_library/windows_registry/enum_values/enum_values.cpp.

Member 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_value< 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 std::vector< string_type >	strings_type
	The string vector type.
typedef traits_type::hkey_type	hkey_type
	The key type.
typedef reg_blob< A >	blob_type
	The blob type.
Construction
	basic_reg_value ()
	Default constructor.
	basic_reg_value (class_type const &rhs)
	Copy constructor.
	~basic_reg_value () throw ()
	Destructor.
class_type &	operator= (class_type const &rhs)
	Copy assignment operator.
	basic_reg_value (hkey_type hkeyParent, string_type const &value_name)
	Internal constructor, used by basic_reg_key and basic_reg_value_sequence.
Public Member Functions
Attributes
ws_dword_t	type () const
	Returns the type of the value.
string_type	name () const
	The name of the value.
string_type	value_sz () const
	The registry value in REG_SZ form.
string_type	value_expand_sz () const
	The registry value in REG_EXPAND_SZ form.
ws_dword_t	value_dword () const
	The registry value as a 32-bit integer.
ws_dword_t	value_dword_littleendian () const
	The registry value as a translated (from little-endian) 32-bit integer.
ws_dword_t	value_dword_bigendian () const
	The registry value as a translated (from big-endian) 32-bit integer.
blob_type	value_binary () const
	The registry value as a binary value.
strings_type	value_multi_sz () const
	The registry value in REG_MULTI_SZ form.

---

Member Typedef Documentation

typedef C char_type

The character type.

typedef T traits_type

The traits type.

typedef A allocator_type

The allocator type.

typedef basic_reg_value<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 std:: vector<string_type> strings_type

The string vector type.

typedef traits_type::hkey_type hkey_type

The key type.

typedef reg_blob<A> blob_type

The blob type.

---

Constructor & Destructor Documentation

basic_reg_value

(

)

Default constructor.

basic_reg_value

(

class_type const &

rhs

)

Copy constructor.

basic_reg_value	(	hkey_type	hkeyParent,
		string_type const &	value_name
	)			[inline, protected]

Internal constructor, used by basic_reg_key and basic_reg_value_sequence.

~basic_reg_value

(

)

throw ()

Destructor.

---

Member Function Documentation

class_type& operator=

(

class_type const &

rhs

)

Copy assignment operator.

ws_dword_t type

(

)

const

Returns the type of the value.

Return values:

	REG_NONE	No value type
	REG_SZ	A Unicode nul terminated string
	REG_EXPAND_SZ	A Unicode nul terminated string (with environment variable references)
	REG_BINARY	A free form binary
	REG_DWORD	A 32-bit number
	REG_DWORD_LITTLE_ENDIAN	A little-endian 32-bit number (same as REG_DWORD)
	REG_DWORD_BIG_ENDIAN	A big-endian 32-bit number
	REG_LINK	A symbolic Link (unicode)
	REG_MULTI_SZ	Multiple Unicode strings
	REG_RESOURCE_LIST	A resource list in the resource map
	REG_FULL_RESOURCE_DESCRIPTOR	A resource list in the hardware description
	REG_RESOURCE_REQUIREMENTS_LIST
	REG_QWORD	A 64-bit number
	REG_QWORD_LITTLE_ENDIAN	A 64-bit number (same as REG_QWORD)

string_type name

(

)

const

The name of the value.

string_type value_sz

(

)

const

The registry value in REG_SZ form.

This method does not expand environment strings

Examples:

by_library/windows_registry/enum_values/enum_values.cpp.

string_type value_expand_sz

(

)

const

The registry value in REG_EXPAND_SZ form.

This method does expand environment strings

Examples:

by_library/windows_registry/enum_values/enum_values.cpp.

ws_dword_t value_dword

(

)

const

The registry value as a 32-bit integer.

ws_dword_t value_dword_littleendian

(

)

const

The registry value as a translated (from little-endian) 32-bit integer.

ws_dword_t value_dword_bigendian

(

)

const

The registry value as a translated (from big-endian) 32-bit integer.

blob_type value_binary

(

)

const

The registry value as a binary value.

strings_type value_multi_sz

(

)

const

The registry value in REG_MULTI_SZ form.

---

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

• winstl/registry/reg_value.hpp