reg_traits Struct Template Reference
[Windows Registry Library]

#include <winstl/registry/reg_traits.hpp>

Inheritance diagram for reg_traits:

List of all members.

Detailed Description

template<typename C>
struct winstl::reg_traits< C >

Traits for accessing the correct registry functions for a given character type.

reg_traits is a traits class for determining the correct registry structures and functions for a given character type.

Parameters:

C

The character type


Public Types
Member Types
typedef C	char_type
	The character type.
typedef size_t	size_type
	The size type.
typedef ws_ptrdiff_t	difference_type
	The difference type.
typedef HKEY	hkey_type
	The registry key type.
typedef reg_string_t	string_type
	The string type.
typedef FILETIME	time_type
	The time type.
typedef LONG	result_type
	The API result type (LONG).
Static Public Member Functions
Operations
static hkey_type	key_dup (hkey_type hkey, REGSAM samDesired=KEY_ALL_ACCESS, result_type *result=NULL)
	Duplicates a registry key.
static hkey_type	reg_dup_key (hkey_type hkey, REGSAM samDesired=KEY_ALL_ACCESS, result_type *result=NULL)
	Duplicates a registry key.
static result_type	reg_open_key (hkey_type hkey, char_type const sub_key_name, hkey_type hkey_result, REGSAM samDesired=KEY_ALL_ACCESS)
	Opens a registry sub-key.
static result_type	reg_create_key (hkey_type hkey, char_type const sub_key_name, hkey_type hkey_result, REGSAM samDesired=KEY_ALL_ACCESS)
	Opens a registry sub-key.
static result_type	reg_create_key (hkey_type hkey, char_type const sub_key_name, hkey_type hkey_result, bool &bCreated, REGSAM samDesired=KEY_ALL_ACCESS)
static result_type	reg_delete_key (hkey_type hkey, char_type const *sub_key_name)
	Destroys a registry sub-key.
static result_type	reg_query_value (hkey_type hkey, char_type const valueName, ws_dword_t &valueType, void data, size_type &cbData)
	Queries a registry key value.
static result_type	reg_set_value (hkey_type hkey, char_type const valueName, ws_dword_t valueType, void const data, size_type cbData)
	Sets the value of the named value.
static result_type	reg_delete_value (hkey_type hkey, char_type const *valueName)
	Deletes the named value.
static result_type	reg_delete_tree (hkey_type hkey, char_type const *sub_key_name)
	Deletes the key and all sub-keys, permissions allowing.
static result_type	reg_query_info (hkey_type hkey, char_type key_class, size_type cch_key_class, ws_uint32_t c_sub_keys, size_type cch_sub_key_max, size_type cch_key_class_max, ws_uint32_t c_values, size_type cch_valueName_max, size_type cb_value_data_max, size_type cb_security_descriptor_max, time_type time_last_write)
	Queries a registry key's characteristics.
static result_type	reg_enum_key (hkey_type hkey, ws_dword_t index, char_type key_name, size_type cch_key_name, time_type *time_last_write=NULL)
	Enumerates a registry key's sub-keys.
static result_type	reg_enum_key (hkey_type hkey, ws_dword_t index, char_type key_name, size_type cch_key_name, char_type key_class, size_type cch_key_class, time_type *time_last_write)
	[DEPRECATED] Enumerates a registry key's sub-keys
static result_type	reg_enum_value (hkey_type hkey, ws_dword_t index, char_type valueName, size_type cch_valueName, ws_dword_t valueType, void data, size_type &cbData)
	Enumerates a registry key's values.
static result_type	reg_enum_value (hkey_type hkey, ws_dword_t index, char_type valueName, size_type cch_valueName)
	Enumerates a registry key's values.

Member Typedef Documentation

typedef C char_type

The character type.

Reimplemented from system_traits.

typedef size_t size_type

The size type.

Reimplemented from system_traits.

typedef ws_ptrdiff_t difference_type

The difference type.

Reimplemented from system_traits.

typedef HKEY hkey_type

The registry key type.

typedef reg_string_t string_type

The string type.

typedef FILETIME time_type

The time type.

typedef LONG result_type

The API result type (LONG).

Member Function Documentation

static hkey_type key_dup	(	hkey_type	hkey,
		REGSAM	samDesired = `KEY_ALL_ACCESS`,
		result_type *	result = `NULL`
	)			`[static]`

Duplicates a registry key.

Deprecated:: Use reg_dup_key() instead

static hkey_type reg_dup_key	(	hkey_type	hkey,
		REGSAM	samDesired = `KEY_ALL_ACCESS`,
		result_type *	result = `NULL`
	)			`[static]`

Duplicates a registry key.

static result_type reg_open_key	(	hkey_type	hkey,
		char_type const *	sub_key_name,
		hkey_type *	hkey_result,
		REGSAM	samDesired = `KEY_ALL_ACCESS`
	)			`[static]`

Opens a registry sub-key.

static result_type reg_create_key	(	hkey_type	hkey,
		char_type const *	sub_key_name,
		hkey_type *	hkey_result,
		REGSAM	samDesired = `KEY_ALL_ACCESS`
	)			`[static]`

Opens a registry sub-key.

static result_type reg_delete_key	(	hkey_type	hkey,
		char_type const *	sub_key_name
	)			`[static]`

Destroys a registry sub-key.

static result_type reg_query_value	(	hkey_type	hkey,
		char_type const *	valueName,
		ws_dword_t &	valueType,
		void *	data,
		size_type &	cbData
	)			`[static]`

Queries a registry key value.

static result_type reg_set_value	(	hkey_type	hkey,
		char_type const *	valueName,
		ws_dword_t	valueType,
		void const *	data,
		size_type	cbData
	)			`[static]`

Sets the value of the named value.

static result_type reg_delete_value	(	hkey_type	hkey,
		char_type const *	valueName
	)			`[static]`

Deletes the named value.

static result_type reg_delete_tree	(	hkey_type	hkey,
		char_type const *	sub_key_name
	)			`[static]`

Deletes the key and all sub-keys, permissions allowing.

static result_type reg_query_info	(	hkey_type	hkey,
		char_type *	key_class,
		size_type *	cch_key_class,
		ws_uint32_t *	c_sub_keys,
		size_type *	cch_sub_key_max,
		size_type *	cch_key_class_max,
		ws_uint32_t *	c_values,
		size_type *	cch_valueName_max,
		size_type *	cb_value_data_max,
		size_type *	cb_security_descriptor_max,
		time_type *	time_last_write
	)			`[static]`

Queries a registry key's characteristics.

static result_type reg_enum_key	(	hkey_type	hkey,
		ws_dword_t	index,
		char_type *	key_name,
		size_type *	cch_key_name,
		time_type *	time_last_write = `NULL`
	)			`[static]`

Enumerates a registry key's sub-keys.

static result_type reg_enum_key	(	hkey_type	hkey,
		ws_dword_t	index,
		char_type *	key_name,
		size_type *	cch_key_name,
		char_type *	key_class,
		size_type *	cch_key_class,
		time_type *	time_last_write
	)			`[static]`

[DEPRECATED] Enumerates a registry key's sub-keys

Deprecated:: This is deprecated in favour of reg_enum_key(hkey_type, ws_dword_t, char_type*, size_type*, time_type *)

static result_type reg_enum_value	(	hkey_type	hkey,
		ws_dword_t	index,
		char_type *	valueName,
		size_type *	cch_valueName,
		ws_dword_t *	valueType,
		void *	data,
		size_type &	cbData
	)			`[static]`

Enumerates a registry key's values.

static result_type reg_enum_value	(	hkey_type	hkey,
		ws_dword_t	index,
		char_type *	valueName,
		size_type *	cch_valueName
	)			`[static]`

Enumerates a registry key's values.

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

winstl/registry/reg_traits.hpp

reg_traits Struct Template Reference [Windows Registry Library]

Detailed Description

template<typename C> struct winstl::reg_traits< C >

Public Types

Static Public Member Functions

Member Typedef Documentation

Member Function Documentation

reg_traits Struct Template Reference
[Windows Registry Library]

template<typename C>
struct winstl::reg_traits< C >