CBaseFilter::Stop

  • Article
 
Microsoft DirectShow 9.0

CBaseFilter::Stop

The Stop method stops the filter. This method implements the IMediaFilter::Stop method.

Syntax

  HRESULT Stop(void);

Return Value

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

Remarks

This method calls the CBasePin::Inactive method on each of the filter's connected pins. It also sets the filter's state to State_Stopped.

When the filter stops, it should reject samples from upstream, stop delivering samples downstream, shut down worker threads, and free any resources that it used for streaming.

Requirements

**  Header:** Declared in Amfilter.h; include Streams.h.

**  Library:** Use Strmbase.lib (retail builds) or Strmbasd.lib (debug builds).

See Also