IFilterGraph::FindFilterByName method (strmif.h)

Article
02/22/2024

[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 FindFilterByName method finds a filter that was added to the filter graph with a specific name.

Syntax

HRESULT FindFilterByName(
  [in]  LPCWSTR     pName,
  [out] IBaseFilter **ppFilter
);

Parameters

[in] pName

[in, string] Pointer to the name to search for.

[out] ppFilter

Receives a pointer to the filter's IBaseFilter interface. The caller must release the interface.

Return value

Returns one of the following values.

Return code	Description
S_OK	Success.
E_POINTER	NULL pointer argument.
VFW_E_NOT_FOUND	No filter was found with the specified name.

Remarks

If no filter is found, the method returns a NULL pointer in the ppFilter parameter.

The returned IBaseFilter interface has an outstanding reference count. The caller must release the interface.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib