CBaseFilter.EnumPins method

[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 EnumPins method enumerates the pins on this filter. This method implements the IBaseFilter::EnumPins method.

Syntax

HRESULT EnumPins(
   IEnumPins **ppEnum
);

Parameters

ppEnum

Address of a variable that receives a pointer to the IEnumPins interface.

Return value

Returns one of the following HRESULT values.

Return code Description
S_OK
Success
E_OUTOFMEMORY
Insufficient memory
E_POINTER
NULL pointer argument

Remarks

This method creates an instance of the CEnumPins base class, and returns a pointer to that object, of type IEnumPins. The CEnumPins class calls the filter's CBaseFilter::GetPin method to enumerate the pins on the filter.

If this method succeeds, the IEnumPins interface has an outstanding reference count. The caller must release the interface.

Requirements

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

See also

CBaseFilter Class