th_sequence_base Class Template Reference
[Windows ToolHelp Library]

#include <winstl/toolhelp/sequence_base.hpp>

List of all members.

---

Detailed Description

template<typename V, typename E = throw_exception_policy<toolhelp_exception>>
class winstl::th_sequence_base< V, E >

Class template for TOOLHELP STL collections.

Examples:

by_library/windows_toolhelp/module_sequence/module_sequence.cpp, and by_library/windows_toolhelp/process_sequence/process_sequence.cpp.

Public Types
Member Types
typedef th_sequence_base< V >	class_type
	The size type.
typedef th_sequence_const_iterator< V >	const_iterator
	The non-mutating (const) iterator type.
typedef const_iterator::value_type	value_type
	The value type.
typedef const_iterator::reference	reference
	The mutating (non-const) reference type.
typedef const_iterator::const_reference	const_reference
	The non-mutating (const) type.
typedef const_iterator::handle_type	handle_type
	The handle type.
typedef const_iterator::traits_type	traits_type
	The traits type.
typedef E	exception_policy
	The exception policy type.
typedef size_t	size_type
	The size type.
Public Member Functions
Construction
	th_sequence_base ()
	Constructs an instance on a TOOLHELP snapshot for the calling process.
	th_sequence_base (DWORD process_id, DWORD=sizeof(sequence_doesnt_use_pid< value_type >))
	Constructs an instance on a TOOLHELP snapshot for the specified process.
	~th_sequence_base ()
	Destructor.
Iteration
const_iterator	begin () const
	Begins the iteration.
const_iterator	end () const
	Ends the iteration.
Attributes
bool	empty () const
	Indicates whether the sequence is empty.

---

Member Typedef Documentation

typedef th_sequence_base<V> class_type

The size type.

typedef th_sequence_const_iterator<V> const_iterator

The non-mutating (const) iterator type.

typedef const_iterator::value_type value_type

The value type.

typedef const_iterator::reference reference

The mutating (non-const) reference type.

typedef const_iterator::const_reference const_reference

The non-mutating (const) type.

typedef const_iterator::handle_type handle_type

The handle type.

typedef const_iterator::traits_type traits_type

The traits type.

typedef E exception_policy

The exception policy type.

typedef size_t size_type

The size type.

---

Constructor & Destructor Documentation

th_sequence_base

(

)

[inline]

Constructs an instance on a TOOLHELP snapshot for the calling process.

th_sequence_base	(	DWORD	process_id,
		DWORD	= sizeof(sequence_doesnt_use_pid<value_type>)
	)			[inline]

Constructs an instance on a TOOLHELP snapshot for the specified process.

~th_sequence_base

(

)

[inline]

Destructor.

---

Member Function Documentation

const_iterator begin

(

)

const [inline]

Begins the iteration.

Returns:

An iterator representing the start of the sequence.

Examples:

by_library/windows_toolhelp/module_sequence/module_sequence.cpp, and by_library/windows_toolhelp/process_sequence/process_sequence.cpp.

const_iterator end

(

)

const [inline]

Ends the iteration.

Returns:

An iterator representing the end of the sequence.

Examples:

by_library/windows_toolhelp/module_sequence/module_sequence.cpp, and by_library/windows_toolhelp/process_sequence/process_sequence.cpp.

bool empty

(

)

const [inline]

Indicates whether the sequence is empty.

---

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

• winstl/toolhelp/sequence_base.hpp