CSourceSeeking.GetStopPosition method

[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 GetStopPosition method retrieves the time when playback will stop, relative to the duration of the stream. This method implements the IMediaSeeking::GetStopPosition method.

Syntax

HRESULT GetStopPosition(
   LONGLONG *pStop
);

Parameters

pStop

Pointer to a variable that receives the stop time, in units of the current time format.

Return value

Returns one of the HRESULT values listed in the following table.

Return code Description
S_OK
Success
E_POINTER
NULL pointer value

Remarks

The stop time is specified by the CSourceSeeking::m_rtStop member variable.

Requirements

Requirement Value
Header
Ctlutil.h (include Streams.h)
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

CSourceSeeking Class