IGraphConfig::AddFilterToCache 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 AddFilterToCache method adds a filter to the filter cache.

Syntax

HRESULT AddFilterToCache(
  [in] IBaseFilter *pFilter
);

Parameters

[in] pFilter

Pointer to the IBaseFilter interface of the filter.

Return value

Returns one of the following HRESULT values.

Return code	Description
E_FAIL	Failure.
E_POINTER	NULL pointer argument.
S_FALSE	Filter is already in the cache.
S_OK	Filter was added to the cache.

Remarks

You must disconnect all of the filter's pins before calling this method, or the method will fail. If the filter is in the filter graph, this method will remove it. This method will also put the filter into a stopped state, if it is not already.

Requirements

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