Share via


IAMWstDecoder::GetHoldPage method (iwstdec.h)

[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.]

Downstream filters use the GetHoldPage method to determine whether the current WST page is held. When the WST decoder holds a page, any updates from the TV stream are turned off. It is though the page was paused in real time.

Syntax

HRESULT GetHoldPage(
  [out] BOOL *pbHoldPage
);

Parameters

[out] pbHoldPage

Pointer to a BOOL to receive the status of the WST page.

Value Description
TRUE The current page is held.
FALSE The current page is not held.

Return value

When the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header iwstdec.h
Library Strmiids.lib

See also

Error and Success Codes

IAMWstDecoder Interface