Microsoft DirectX 8.1 (C++)

IAMWstDecoder::GetHoldPage

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(
  BOOL*  pbHoldPage
);

Parameters

pbHoldPage

[out]  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 Values

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

See Also