pid_sequence Class Reference
[System Library]

#include <winstl/system/pid_sequence.hpp>

Inheritance diagram for pid_sequence:

List of all members.

---

Detailed Description

Process Id sequence.

Public Types
Member Types
enum	{   elideIdle = 0x0001,   elideSystem = 0x0002,   sort = 0x0004 }
typedef DWORD	value_type
	The value type.
typedef processheap_allocator < value_type >	allocator_type
	The allocator type.
typedef pid_sequence	class_type
	The class type.
typedef value_type const *	const_pointer
	The non-mutating (const) pointer type.
typedef value_type const &	const_reference
	The non-mutating (const) reference type.
typedef stlsoft::pointer_iterator < value_type, const_pointer, const_reference >::type	const_iterator
	The non-mutating (const) iterator type.
typedef size_t	size_type
	The size type.
typedef ws_ptrdiff_t	difference_type
	The difference type.
Public Member Functions
Construction
	pid_sequence (ws_uint32_t flags=elideIdle|elideSystem)
	Constructs a sequence from the current processes in the host system.
	pid_sequence (class_type const &rhs)
	Copies the contents of the sequence.
	~pid_sequence () throw ()
	Releases the storage associated with the process id list.
Iteration
const_iterator	begin () const
	Begins the iteration.
const_iterator	end () const
	Ends the iteration.
Element Access
const_reference	operator[] (size_type index) const
	Returns a reference to the element at the given index.
Attributes
bool	empty () const
	Indicates whether the sequence is empty.
size_type	size () const
	Returns the number of identifiers in the sequence.
Static Public Member Functions
System Traits
static value_type	idleProcessId ()
	The process identifier of the Idle process.
static value_type	systemProcessId ()
	The process identifier of the System process.

---

Member Typedef Documentation

typedef DWORD value_type

The value type.

typedef processheap_allocator<value_type> allocator_type

The allocator type.

typedef pid_sequence class_type

The class type.

typedef value_type const* const_pointer

The non-mutating (const) pointer type.

typedef value_type const& const_reference

The non-mutating (const) reference type.

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

The non-mutating (const) iterator type.

typedef size_t size_type

The size type.

typedef ws_ptrdiff_t difference_type

The difference type.

---

Constructor & Destructor Documentation

pid_sequence

(

ws_uint32_t

flags = elideIdle|elideSystem

)

[explicit]

Constructs a sequence from the current processes in the host system.

pid_sequence

(

class_type const &

rhs

)

Copies the contents of the sequence.

~pid_sequence

(

)

throw ()

Releases the storage associated with the process id list.

---

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

const_reference operator[]

(

size_type

index

)

const

Returns a reference to the element at the given index.

Parameters:

index

The required index. Behaviour is undefined, if not within the range [0, size())

bool empty

(

)

const

Indicates whether the sequence is empty.

size_type size

(

)

const

Returns the number of identifiers in the sequence.

static value_type idleProcessId

(

)

[inline, static]

The process identifier of the Idle process.

Note:

The Idle process is a pseudo-process. You should not attempt to manipulate it using the process control functions

static value_type systemProcessId

(

)

[inline, static]

The process identifier of the System process.

Note:

The System process is a pseudo-process. You should not attempt to manipulate it using the process control functions

References system_version::major(), and system_version::minor().

---

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

• winstl/system/pid_sequence.hpp