Edit

Share via

CBaseFilter.FindPin 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 FindPin method retrieves the pin with the specified identifier. This method implements the IBaseFilter::FindPin method.

Syntax

HRESULT FindPin(
   LPCWSTR Id,
   IPin    **ppPin
);

Parameters

Id

Pointer to a constant, null-terminated Unicode string that identifies the pin.

ppPin

Address of a variable that receives a pointer to the pin's IPin interface.

Return value

Returns one of the following HRESULT values.

Return code Description
S_OK
 Success.
E_POINTER
 NULL pointer argument.
VFW_E_NOT_FOUND
 Could not find a matching pin.

Remarks

This method calls the CBasePin::Name method to compare each pin's name against the string specified by the Id parameter.

If the method succeeds, the IPin interface has an outstanding reference count. Be sure to release it when you are done.

Requirements

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

See also

CBaseFilter Class