Share via


IMSVidClosedCaptioning::put_Enable method (segment.h)

[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]

The put_Enable method enables or disables closed captioning.

Syntax

HRESULT put_Enable(
  [in] VARIANT_BOOL On
);

Parameters

[in] On

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

Requirement Value
Minimum supported client Windows�XP [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header segment.h (include Msvidctl.h)

See also

IMSVidClosedCaptioning Interface

IMSVidClosedCaptioning::get_Enable