---

basic_environment_sequence Class Template Reference
[System Library (WinSTL)]

STL-like sequence for the system environment variables. More...

#include <winstl_environment_sequence.h>

List of all members.

Public Types
typedef C	char_type
	The character type.
typedef symbol	value_type
	The value type.
typedef basic_environment_sequence< C >	class_type
	The current parameterisation of the type.
typedef const value_type *	const_pointer
	The non-mutable (const) pointer type.
typedef const value_type &	const_reference
	The non-mutable (const) reference type.
typedef ws_size_t	size_type
	The size type.
typedef ws_ptrdiff_t	difference_type
	The difference type.
typedef ::stlsoft::pointer_iterator< value_type, const_pointer, const_reference >::iterator_type	const_iterator
	The non-mutating (const) iterator type.
typedef ::stlsoft::const_reverse_iterator_base< const_iterator, value_type, const_reference, const_pointer, difference_type >	const_reverse_iterator
	The non-mutating (const) reverse iterator type.
Public Methods
	basic_environment_sequence ()
	Default constructor.
	~basic_environment_sequence () winstl_throw_0()
	Destructor, which releases any resources acquired.
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 elements in the enviroment sequence.
ws_bool_t	empty () const
	Indicates whether the enviroment sequence is empty.
value_type	operator[] (size_type index) const
	Returns the name-value item for the given index.

---

Detailed Description

template<typename C>
class winstl::basic_environment_sequence< C >

STL-like sequence for the system environment variables.

Parameters:

C	The character type

---

Member Typedef Documentation

typedef C char_type

The character type.

typedef basic_environment_sequence<C> class_type

The current parameterisation of the type.

typedef ::stlsoft:: pointer_iterator< value_type , const_pointer , const_reference >::iterator_type const_iterator

The non-mutating (const) iterator type.

typedef const value_type* const_pointer

The non-mutable (const) pointer type.

typedef const value_type& const_reference

The non-mutable (const) reference type.

typedef ::stlsoft:: const_reverse_iterator_base< const_iterator , value_type , const_reference , const_pointer , difference_type > const_reverse_iterator

The non-mutating (const) reverse iterator type.

typedef ws_ptrdiff_t difference_type

The difference type.

typedef ws_size_t size_type

The size type.

typedef symbol value_type

The value type.

---

Constructor & Destructor Documentation

basic_environment_sequence (    )

Default constructor.

~basic_environment_sequence (    )

Destructor, which releases any resources acquired.

---

Member Function Documentation

const_iterator begin (    )

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

ws_bool_t empty (    )

Indicates whether the enviroment sequence is empty.

const_iterator end (    )

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

value_type operator[] (  size_type    index )  const

Returns the name-value item for the given index.

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 elements in the enviroment sequence.

---

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

• winstl_environment_sequence.h

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