IVCmdAttributes::EnabledGet

HRESULT EnabledGet(DWORD *dwEnabled);

Finds out whether speech recognition is enabled or disabled for a voice-command site.

· Returns NOERROR if successful, or one of these error values:

E_INVALIDARG
VCMDERR_INVALIDMODE
VCMDERR_OUTOFMEM
VCMDERR_VALUEOUTOFRANGE

dwEnabled

[out] TRUE if speech recognition is enabled for the site or FALSE if it is disabled.

When speech recognition is disabled, the engine does not recognize any command from any menu, whether speech recognition is awake or asleep or any menus are active. An application would use the IVCmdAttributes::EnabledSet member function to allow the user to turn speech recognition completely off, as opposed to suspending speech recognition temporarily by putting the site to sleep.

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