IAMWstDecoder::SetHoldPage

  • Article
 
Microsoft DirectShow 9.0

IAMWstDecoder::SetHoldPage

Downstream filters use the SetHoldPage method to tell the WST decoder to hold the current WST page. When the WST decoder holds a page, any updates from the TV stream are turned off. It is as though the page was paused in real time.

Syntax

  HRESULT SetHoldPage(
  
  BOOL
  
  bHoldPage
  
  );

Parameters

bHoldPage

[in]  Specifies whether to hold the current page.

Value Description
TRUE Hold the current page.
FALSE Release the current page.

Return Values

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

Requirements

Header: Include Iwstdec.h.

Library: Use Strmiids.lib.

See Also