Share via


IMSVidClosedCaptioning::get_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 get_Enable method queries whether closed captioning is enabled.

Syntax

HRESULT get_Enable(
  [out] VARIANT_BOOL *On
);

Parameters

[out] On

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

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