IMediaSeeking::GetStopPosition method (strmif.h)

Article
02/22/2024

[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 at which the playback will stop, relative to the duration of the stream.

Syntax

HRESULT GetStopPosition(
  [out] LONGLONG *pStop
);

Parameters

[out] pStop

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

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
S_OK	Success.
E_NOTIMPL	Method is not supported.
E_POINTER	NULL pointer argument.

Remarks

The playback rate does not affect the value returned by this method.

The returned value is expressed in the current time format. The default time format is REFERENCE_TIME units (100 nanoseconds). To change time formats, use the IMediaSeeking::SetTimeFormat method.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib