---

basic_searchpath_sequence Class Template Reference
[File-System Library (WinSTL)]

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

#include <winstl_searchpath_sequence.h>

List of all members.

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 const value_type *	const_pointer
	The non-mutable (const) pointer type.
typedef value_type &	reference
	The reference 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_searchpath_sequence ()
	Determines the search path sequence for the calling process.
	basic_searchpath_sequence (ws_bool_t bIncludeApplicationDirectory, ws_bool_t bIncludeCurrentDirectory, ws_bool_t bApplicationDirectoryFirst=true)
	Determines the search path sequence for the calling process.
	~basic_searchpath_sequence () winstl_throw_0()
	Releases any resources.
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 items in the sequence.
ws_bool_t	empty () const
	Indicates whether the sequence is empty.
value_type	operator[] (size_type index) const
	Returns the item at the given index.
Static Public Methods
size_type	max_size ()
	Returns the maximum number of items in the sequence.

---

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>

---

Member Typedef Documentation

typedef C char_type

The character type.

typedef basic_searchpath_sequence<C, T> 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 value_type* pointer

The pointer type.

typedef value_type& reference

The reference type.

typedef ws_size_t size_type

The size type.

typedef T traits_type

The traits type.

typedef char_type const* value_type

The value 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 (  ws_bool_t    bIncludeApplicationDirectory, ws_bool_t    bIncludeCurrentDirectory, ws_bool_t    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 (    )

Releases any resources.

---

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 sequence is empty.

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

value_type operator[] (  size_type    index )  const

Returns the item at 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 items in the sequence.

---

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

• winstl_searchpath_sequence.h

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