basic_searchpath_sequence Class Template Reference
[System Library]

#include <winstl/system/searchpath_sequence.hpp>

Inheritance diagram for basic_searchpath_sequence:

List of all members.

---

Detailed Description

template<typename C, typename T = filesystem_traits<C>>
class winstl::basic_searchpath_sequence< C, T >

Presents an STL-like sequence interface to the search path sequence for the current process.

Parameters:

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

Public Types
typedef C	char_type
	The character type.
typedef T	traits_type
	The traits type.
typedef basic_searchpath_sequence< C, T >	class_type
	The current parameterisation of the type.
typedef char_type const *	value_type
	The value type.
typedef value_type *	pointer
	The pointer type.
typedef value_type const *	const_pointer
	The non-mutable (const) pointer type.
typedef value_type &	reference
	The reference type.
typedef value_type const &	const_reference
	The non-mutable (const) reference type.
typedef 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 >::type	const_iterator
	The non-mutating (const) iterator type.
Public Member Functions
	basic_searchpath_sequence ()
	Determines the search path sequence for the calling process.
	basic_searchpath_sequence (bool bIncludeApplicationDirectory, bool bIncludeCurrentDirectory, bool bApplicationDirectoryFirst=true)
	Determines the search path sequence for the calling process.
	~basic_searchpath_sequence () throw ()
	Releases any resources.
const_iterator	begin () const
	Begins the iteration.
const_iterator	end () const
	Ends the iteration.
size_type	size () const
	Returns the number of items in the sequence.
bool	empty () const
	Indicates whether the sequence is empty.
value_type	operator[] (size_type index) const
	Returns the item at the given index.
Static Public Member Functions
static size_type	max_size ()
	Returns the maximum number of items in the sequence.

---

Member Typedef Documentation

typedef C char_type

The character type.

typedef T traits_type

The traits type.

typedef basic_searchpath_sequence<C, T> class_type

The current parameterisation of the type.

typedef char_type const* value_type

The value type.

typedef value_type* pointer

The pointer type.

typedef value_type const* const_pointer

The non-mutable (const) pointer type.

typedef value_type& reference

The reference type.

typedef value_type const& const_reference

The non-mutable (const) reference type.

typedef 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>::type const_iterator

The non-mutating (const) iterator type.

---

Constructor & Destructor Documentation

basic_searchpath_sequence

(

)

Determines the search path sequence for the calling process.

Note:

The process directory appears before the current directory

basic_searchpath_sequence	(	bool	bIncludeApplicationDirectory,
		bool	bIncludeCurrentDirectory,
		bool	bApplicationDirectoryFirst = true
	)

Determines the search path sequence for the calling process.

Parameters:

	bIncludeApplicationDirectory	If this is true the application directory is included in the search path sequence
	bIncludeCurrentDirectory	If this is true the current directory is included in the search path sequence
	bApplicationDirectoryFirst	If this is true the process directory is placed before the current directory in the search (the normal loading sequence). If not, then the current directory comes first.

~basic_searchpath_sequence

(

)

throw ()

Releases any resources.

---

Member Function Documentation

const_iterator begin

(

)

const

Begins the iteration.

Returns:

An iterator representing the start of the sequence

const_iterator end

(

)

const

Ends the iteration.

Returns:

An iterator representing the end of the sequence

size_type size

(

)

const

Returns the number of items in the sequence.

bool empty

(

)

const

Indicates whether the sequence is empty.

static size_type max_size

(

)

[static]

Returns the maximum number of items in the sequence.

value_type operator[]

(

size_type

index

)

const

Returns the item at the given index.

---

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

• winstl/system/searchpath_sequence.hpp