IRsEnumCmdDesc Interface Reference

Inherits IUnknown.

List of all members.

Public Member Functions
HRESULT	Next ([in] ULONG cCmds,[out] IRsCmdDesc **ppCmdDescArray,[out] ULONG *pcFetched)
HRESULT	Skip ([in] ULONG cCmd)
HRESULT	Reset (void)
HRESULT	Clone ([out] IRsEnumCmdDesc **ppEnum)

---

Detailed Description

Enumerator of command descriptors

---

Member Function Documentation

HRESULT IRsEnumCmdDesc::Next	(	[in] ULONG	cCmds,
		[out] IRsCmdDesc **	ppCmdDescArray,
		[out] ULONG *	pcFetched
	)

Parameters:

	cCmds	[in] number of items elements being requested
	ppCmdDescArray	[out] Array of size cCmds (or larger) of the items of interest
	pcFetched	[out] pointer to the number of elements actually supplied in ppCmdDescArray

HRESULT IRsEnumCmdDesc::Skip

(

[in] ULONG

cCmd

)

Skips over the next specified number of elements in the enumeration sequence

Parameters:

cCmd

[in] Number of elements to be skipped

HRESULT IRsEnumCmdDesc::Reset

(

void

)

Resets the enumeration sequence to the beginning

HRESULT IRsEnumCmdDesc::Clone

(

[out] IRsEnumCmdDesc **

ppEnum

)

Creates another enumerator that contains the same enumeration state as the current one. Using this function, a client can record a particular point in the enumeration sequence and then return to that point at a later time. The new enumerator supports the same interface as the original one.

Parameters:

ppEnum

[out] Address of IRsEnumCmdDesc pointer variable that receives the interface pointer to the enumeration object. If the method is unsuccessful, the value of this output variable is undefined.