basic_environment_variable Class Template Reference
[System Library]

#include <winstl/system/environment_variable.hpp>

List of all members.

---

Detailed Description

template<typename C, typename T = system_traits<C>>
class winstl::basic_environment_variable< C, T >

Represents an environment variable.

Parameters:

	C	The character type
	T	The traits type. On translators that support default template arguments, this defaults to system_traits<C>

Public Types
typedef C	char_type
	The char type.
typedef T	traits_type
	The traits type.
typedef processheap_allocator< C >	allocator_type
	The allocator type.
typedef basic_environment_variable< C, T >	class_type
	The current parameterisation of the type.
typedef size_t	size_type
	The size type.
typedef ws_ptrdiff_t	difference_type
	The difference type.
Public Member Functions
	basic_environment_variable (char_type const *name)
	Create an instance representing the given environment variable.
template<typename S>
	basic_environment_variable (S const &name)
	Create an instance representing the given environment variable.
	operator char_type const * () const
	Implicit conversion to a non-mutable (const) pointer to the variable.
char_type const *	c_str () const
	Returns a pointer to a nul-terminated string.
size_type	length () const
	Returns the length of the variable.

---

Member Typedef Documentation

typedef C char_type

The char type.

typedef T traits_type

The traits type.

typedef processheap_allocator<C> allocator_type

The allocator type.

typedef basic_environment_variable<C, T> class_type

The current parameterisation of the type.

typedef size_t size_type

The size type.

typedef ws_ptrdiff_t difference_type

The difference type.

---

Constructor & Destructor Documentation

basic_environment_variable

(

char_type const *

name

)

[inline, explicit]

Create an instance representing the given environment variable.

basic_environment_variable

(

S const &

name

)

[inline, explicit]

Create an instance representing the given environment variable.

References stlsoft_ns_qual.

---

Member Function Documentation

operator char_type const *

(

)

const [inline]

Implicit conversion to a non-mutable (const) pointer to the variable.

char_type const* c_str

(

)

const [inline]

Returns a pointer to a nul-terminated string.

size_type length

(

)

const [inline]

Returns the length of the variable.

---

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

• winstl/system/environment_variable.hpp