IEnumPins::Clone

  • Article
 
Microsoft DirectShow 9.0

IEnumPins::Clone

The Clone method makes a copy of the enumerator with the same enumeration state.

Syntax

  HRESULT Clone(
  IEnumPins **ppEnum
);

Parameters

ppEnum

[out] Receives a pointer to the IEnumPins interface of the new enumerator. The caller must release the interface.

Return Values

Returns one of the following HRESULT

Value Description
S_OK Success.
E_OUTOFMEMORY Insufficient memory.
E_POINTER NULL pointer argument.
VFW_E_ENUM_OUT_OF_SYNC The filter's state has changed and is now inconsistent with the enumerator.

Remarks

If the number of pins changes, the enumerator is no longer consistent with the filter, and the method returns VFW_E_ENUM_OUT_OF_SYNC. Discard any data obtained from previous calls to the enumerator, because it might be invalid. Update the enumerator by calling the IEnumPins::Reset method. You can then call the Clone method safely.

Requirements

Header: Declared in Strmif.h; include Dshow.h.

Library: Use Strmiids.lib.

See Also