Edit

Share via

IAgentCommand::SetCaption

  • Article

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

HRESULT SetCaption(
   BSTR bszCaption  // Caption setting for Command
);

Sets the Caption text displayed for a Command.

  • Returns S_OK to indicate the operation was successful.

bszCaption

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

Setting the Caption property for a Command defines how it will appear on the character's pop-up menu when its Visible property is set to True and your application is not the input-active client. To specify an access key (unlined mnemonic) for your Caption, include an ampersand (&) character before that character. To make it selectable, its Enabled property must be set to True.

See Also

IAgentCommand::GetCaption, IAgentCommand::SetEnabled, IAgentCommand::SetVisible, IAgentCommand::SetVoice, IAgentCommands::Add, IAgentCommands::Insert