Share via


IMSVidClosedCaptioning::put_Enable Method

This topic applies to Windows XP or later.
The put_Enable method enables or disables closed captioning.

Syntax

HRESULT put_Enable(
  [in]  VARIANT_BOOL On
);

Parameters

  • On [in]
    Specifies whether to enable or disable the closed captioning feature. Use one of the following values.

    Value Description
    VARIANT_TRUE Enable closed captioning.
    VARIANT_FALSE Disable closed captioning.

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::get_Enable

Send comments about this topic to Microsoft

Build date: 12/4/2008