---

basic_reg_value_sequence Class Template Reference
[Registry Library]

Presents an STL-like sequence interface over the values of a given registry key. More...

#include <winstl_reg_value_sequence.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_value_sequence< C, T, A >	class_type
	The current parameterisation of the type.
typedef basic_reg_value< C, T, A >	value_type
	The value type.
typedef traits_type::size_type	size_type
	The size type.
typedef basic_reg_key< C, T, A >	reg_key_type
	The get key type.
typedef basic_reg_value_sequence_const_iterator< C, T, value_type, A >	const_iterator
	The non-mutating (const) iterator type.
typedef value_type &	reference
	The reference type.
typedef value_type const &	const_reference
	The non-mutable (const) reference type.
typedef traits_type::hkey_type	hkey_type
	The hkey type.
typedef ws_ptrdiff_t	difference_type
	The difference type.
typedef ::stlsoft::const_reverse_bidirectional_iterator_base< const_iterator, value_type, value_type, void *, difference_type >	const_reverse_iterator
	The non-mutating (const) reverse iterator type.
Public Methods
	basic_reg_value_sequence (hkey_type hkey, char_type const *sub_key_name)
	Creates an instance on the named sub-key of hkey.
	basic_reg_value_sequence (reg_key_type const &key)
	Creates an instance on the given key.
	~basic_reg_value_sequence () winstl_throw_0()
	Destructor.
const_iterator	begin () const
	Begins the iteration.
const_iterator	end () const
	Ends the iteration.
const_reverse_iterator	rbegin () const
	Begins the reverse iteration.
const_reverse_iterator	rend () const
	Ends the reverse iteration.
size_type	size () const
	Returns the number of values.
ws_bool_t	empty () const
	Evalulates whether there are no values.
Static Public Methods
size_type	max_size ()
	Returns the maximum number of values.

---

Detailed Description

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

Presents an STL-like sequence interface over the values of a given 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_value_sequence<C, T, A> class_type

The current parameterisation of the type.

typedef basic_reg_value_sequence_const_iterator<C, T, value_type, A> const_iterator

The non-mutating (const) iterator type.

typedef value_type const& const_reference

The non-mutable (const) reference type.

typedef ::stlsoft:: const_reverse_bidirectional_iterator_base< const_iterator , value_type , value_type , void* , difference_type > const_reverse_iterator

The non-mutating (const) reverse iterator type.

typedef ws_ptrdiff_t difference_type

The difference type.

typedef traits_type::hkey_type hkey_type

The hkey type.

typedef value_type& reference

The reference type.

typedef basic_reg_key<C, T, A> reg_key_type

The get key type.

typedef traits_type::size_type size_type

The size type.

typedef T traits_type

The traits type.

typedef basic_reg_value<C, T, A> value_type

The value type.

---

Constructor & Destructor Documentation

basic_reg_value_sequence (  hkey_type    hkey, char_type const *    sub_key_name )

Creates an instance on the named sub-key of hkey.

basic_reg_value_sequence (  reg_key_type const &    key )

Creates an instance on the given key.

~basic_reg_value_sequence (    )

Destructor.

---

Member Function Documentation

const_iterator begin (    )

Begins the iteration. Returns: An iterator representing the start of the sequence

ws_bool_t empty (    )

Evalulates whether there are no values.

const_iterator end (    )

Ends the iteration. Returns: An iterator representing the end of the sequence

size_type max_size (    )  [static]

Returns the maximum number of values.

const_reverse_iterator rbegin (    )

Begins the reverse iteration. Returns: An iterator representing the start of the reverse sequence

const_reverse_iterator rend (    )

Ends the reverse iteration. Returns: An iterator representing the end of the reverse sequence

size_type size (    )

Returns the number of values.

---

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

• winstl_reg_value_sequence.h

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