IMediaFilter::Stop method

The Stop method stops the filter.

Syntax


HRESULT Stop();

Parameters

This method has no parameters.

Return value

Returns an HRESULT value. Possible values include those shown in the following table.

Return codeDescription
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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Strmif.h (include Dshow.h)

Library

Strmiids.lib

See also

Error and Success Codes
IMediaFilter Interface
FILTER_STATE Enumeration

 

 

Show: