Share via


CBaseFilter::Pause

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

Transitions the filter to State_Paused state if it is not in this state already.

Syntax

HRESULT Pause (void);

Parameters

None.

Return Value

Returns an HRESULT value.

Remarks

This member function implements the IMediaFilter::Pause method.

If the filter is in State_Stopped state, the CBasePin::Active member function is called for each of the filter's pins to which it is connected.

If this member function succeeds, the filter's m_State member variable is set to State_Paused.

If any pin returns a failure return value from its Active method, the function fails and the state is not changed.

This member function holds the filter's lock.

Requirements

Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Windows Mobile Version 5.0 and later
Note Microsoft DirectShow applications and DirectShow filters have different include file and Library requirements
For more information, see Setting Up the Build Environment