Edit

CEnumPins.Skip method

  • Article

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The Skip method skips over a specified number of pins in the enumeration sequence. This method implements the IEnumPins::Skip method.

Syntax

HRESULT Skip(
   ULONG cPins
);

Parameters

cPins

Number of pins to skip.

Return value

Returns one of the HRESULT values shown in the following table.

Return code Description
S_FALSE
 Skipped past the end of the sequence.
S_OK
 Success.
VFW_E_ENUM_OUT_OF_SYNC
 The filter's state has changed and is now inconsistent with the enumerator.

Requirements

Requirement Value
Header
Amfilter.h (include Streams.h)
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

CEnumPins Class