IAgentCommandEx::SetVoiceCaption

HRESULT SetVoiceCaption(
   BSTR bszVoiceCaption  // voice caption text
);

Sets the VoiceCaption text displayed for a Command.

• Returns S_OK to indicate the operation was successful.

bszVoiceCaption

A BSTR that specifies the text for the VoiceCaption property for a Command.

If you define a Command object in a Commands collection and set its Voice property, you will typically also set its VoiceCaption property. This text will appear in the Voice Commands Window when your client application is input active. If this property is not set, the setting for the Caption property determines the text displayed. When neither the VoiceCaption or Caption property is set, the command does not appear in the Voice Commands Window.

See Also

IAgentCommand::GetCaption, IAgentCommand::SetEnabled, IAgentCommand::SetVisible, IAgentCommand::SetVoice, IAgentCommandsEx::AddEx, IAgentCommandsEx::InsertEx, IAgentCommands::Add, IAgentCommands::Insert