Edit

Share via

IAgentCommandsEx::GetGlobalVoiceCommandsEnabled

  • Article

[Microsoft Agent is deprecated as of Windows 7, and may be unavailable in subsequent versions of Windows.]

HRESULT GetGlobalVoiceCommandsEnabled(
   long * pbEnabled  // address of the global voice command setting
);

Retrieves whether the voice grammar for Agent's global commands is enabled.

  • Returns S_OK to indicate the operation was successful.

pbEnabled

The address that receives True if the voice grammar for Agent's global commands is enabled, False if disabled.

Microsoft Agent automatically adds voice parameters (grammar) for opening and closing the Voice Commands Window and for showing and hiding the character. When this method returns False, any voice parameters for these commands as well as the voice parameters for the Caption of other clients' Command objects are not included in the grammar. This enables you to eliminate these from your client's current active grammar. However, this setting does not reflect the inclusion of these commands in the character's pop-up menu.

See Also

IAgentCommandsEx::SetGlobalVoiceCommandsEnabled