IMediaFilter::Stop
| Microsoft DirectShow 9.0 |
IMediaFilter::Stop
The Stop method stops the filter.
Syntax
HRESULT Stop(void);
Return Values
Returns an HRESULT value. Possible values include those shown in the following table.
| Return code | Description |
| S_FALSE | Transition is not complete. |
| S_OK | Success. Transition is complete. |
Remarks
When a filter is stopped, it does not process or deliver any samples, and it rejects samples from upstream filters.
The state transition might be asynchronous. If the method returns before the transition completes, the return value is S_FALSE.
This method always sets the filter's state to State_Stopped, even if the method returns an error code.
Requirements
Header: Declared in Strmif.h; include Dshow.h.
Library: Use Strmiids.lib.
See Also