IFilterChain::StopChain method (strmif.h)

[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 StopChain method switches all the filters in a filter chain into a stopped state.

Syntax

HRESULT StopChain(
  [in] IBaseFilter *pStartFilter,
  [in] IBaseFilter *pEndFilter
);

Parameters

[in] pStartFilter

A pointer to the IBaseFilter interface of the filter at the start of the chain.

[in] pEndFilter

Pointer to the filter at the end of the chain. If this parameter is NULL, the method uses the longest possible filter chain that extends downstream from the start filter.

Return value

Returns S_OK if successful, or an HRESULT value indicating the cause of the failure otherwise.

Requirements

See also

Error and Success Codes

IFilterChain Interface