IVTxtAttributes::EnabledGet

This method retrieves whether voice text is enabled for a voice text site.

Syntax

HRESULT EnabledGet( DWORD *dwEnabled);

Parameters

dwEnabled

[out] Specifies whether voice text is enabled. TRUE indicates that voice text is enabled for the site; FALSE indicates it is disabled.

Return Values

NOERROR

The method successfully retrieved whether voice text is enabled for a voice text site.

VTXTERR_INVALIDMODE

The text-to-speech mode is invalid, or the application has not been registered to use the voice text on the site.

VTXTERR_INVALIDPARAM

A parameter is invalid.

VTXTERR_OUTOFMEM

There is not enough memory.

Remarks

If voice text is disabled, no text-to-speech is played over the site. Enabling or disabling voice text for a site affects all applications using a voice text site.

Typically, an application disables voice text because the user does not want the computer to speak.

The enabled state for a site is saved between uses of the site, even if the user shuts down the computer in the meantime.

See Also

IVTxtAttributes::EnabledSet