Microsoft DirectX 8.0

IEnumComponentTypes Interface

This interface is implemented on a standard COM collection of ComponentType objects associated with a given broadcast stream, and returned through a call to IComponentTypes::EnumComponentTypes.

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

IEnumComponentTypes::Clone

IEnumComponentTypes Interface

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

Syntax

HRESULT Clone(
    IEnumComponentTypes** ppEnum
    );

Parameters

ppEnum
[out] Address of an IEnumComponentTypes interface pointer that will be set to the returned collection object.

Return Value

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

IEnumComponentTypes::Next

IEnumComponentTypes Interface

Retrieves the next n elements in the collection.

Syntax

HRESULT Next(
    ULONG celt,
    IComponentType** 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 IComponentType interface pointers that will receive the returned ComponentType objects.
pceltFetched
[out] Pointer to a variable of type ULONG that will receive the number of elements actually retrieved.

Return Value

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

IEnumComponentTypes::Reset

IEnumComponentTypes 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.

IEnumComponentTypes::Skip

IEnumComponentTypes Interface

Skips the element at the specified index.

Syntax

HRESULT Skip(
    ULONG celt
    );

Parameters

celt
[in] Index of the element to skip.

Return Value

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