Microsoft DirectX 8.0

IEnumTuningSpaces Interface

This interface is implemented on a standard COM collection of tuning space objects on the local system and returned through a call to ITuningSpaceContainer::EnumTuningSpaces.

MethodNameDescription
NextRetrieves the next n elements in the collection.
SkipSkips the specified element in the collection.
ResetMoves the iterator to the beginning of the collection.
CloneCreates a new copy of the collection and all its sub-objects.

IEnumTuningSpaces::Next

IEnumTuningSpaces Interface

Retrieves the next n elements in the collection.

Syntax

HRESULT Next(
    ULONG celt,
    ITuningSpace** rgelt,
    ULONG* pceltFetched
    );

Parameters

celt
[in] The number of elements to retrieve.
rgelt
[out, size_is(celt), length_is(*pceltFetched)] Address of an array of ITuningSpace interface pointers that will receive the retrieved tuning space objects.
pceltFetched
[out] Pointer to a variable of type ULONG that receives the number of elements actually retrieved.

Return Value

Returns S_OK if successful. This method will succeed even if celt is zero. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

IEnumTuningSpaces::Skip

IEnumTuningSpaces Interface

Skip the specified element in the collection.

Syntax

HRESULT Skip(
    ULONG celt
    );

Parameters

celt
[in] The index of the element to skip.

Return Value

Returns S_OK if successful. This method will succeed even if celt is zero. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

IEnumTuningSpaces::Reset

IEnumTuningSpaces Interface

Moves the iterator to the beginning of the collection.

Syntax

HRESULT Reset();

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

IEnumTuningSpaces::Clone

IEnumTuningSpaces Interface

Create a new copy of the collection and all its sub-objects.

Syntax

HRESULT Clone(
    IEnumTuningSpaces** ppEnum
    );

Parameters

ppEnum
[out] Address of an IEnumTuningSpaces interface pointer that will receive the returned interface.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.