IMSVidClosedCaptioning::get_Enable

  • Article
 
Microsoft DirectShow 9.0

IMSVidClosedCaptioning::get_Enable

This topic applies to Windows XP or later.

The get_Enable method queries whether closed captioning is enabled.

Syntax

  HRESULT get_Enable(
  
  VARIANT_BOOL* 
  pOn
  
  );

Parameters

  pOn

[out]  Pointer to a variable that receives one of the following values.

Value Description
VARIANT_TRUE Closed captioning is enabled.
VARIANT_FALSE Closed captioning is disabled.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Requirements

  Header: Dshow.h.

  Library: Quartz.dll.

See Also