Share via

IMSVidClosedCaptioning::get_Enable Method

  • Article

This topic applies to Windows XP or later.
The get_Enable method queries whether closed captioning is enabled.

Syntax

HRESULT get_Enable(
  [out]  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 Value

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

Requirements

Header Declared in Dshow.h.
DLL Requires Quartz.dll.

See Also

IMSVidClosedCaptioning Interface
IMSVidClosedCaptioning::put_Enable

Send comments about this topic to Microsoft

Build date: 12/4/2008