Edit

IAgentNotifySinkEx::HelpComplete

  • Article

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

HRESULT HelpComplete(
   long dwCharID,     // character ID
   long dwCommandID,  // command ID
   long dwCause       // cause 
);

Notifies a client application when the user selects a command or character to complete Help mode.

  • No return value.

dwCharID

Identifier of the character for which Help mode completed.

dwCommandID

Identifier of the command the user selected.

dwCause

The cause for the event, which may be the following values:

Value Description
const unsigned short CSHELPCAUSE_COMMAND = 1;
 The user selected a command supplied by your application.
const unsigned short CSHELPCAUSE_OTHERPROGRAM = 2;
 The user selected the Commands object of another client.
const unsigned short CSHELPCAUSE_OPENCOMMANDSWINDOW = 3;
 The user selected the Open Voice Commands command.
const unsigned short CSHELPCAUSE_CLOSECOMMANDSWINDOW = 4;
 The user selected the Close Voice Commands command.
const unsigned short CSHELPCAUSE_SHOWCHARACTER = 5;
 The user selected the Show CharacterName command.
const unsigned short CSHELPCAUSE_HIDECHARACTER = 6;
 The user selected the Hide CharacterName command.
const unsigned short CSHELPCAUSE_CHARACTER = 7;
 The user selected (clicked) the character.

Typically Help mode completes when the user clicks or drags the character or selects a command from the character's pop-up menu. Clicking on another character or elsewhere on the screen does not cancel Help mode. The client that set Help mode for the character can cancel Help mode by setting IAgentCharacter::HelpModeOn to False. (This does not trigger the IAgentNotifySinkEx::HelpComplete event.)

When the user selects a command from the character's pop-up menu in Help mode, the server removes the menu, calls Help with the command's specified HelpContextID, and sends this event. The context-sensitive (also known as What's This?) Help window is displayed at the pointer location. If the user selects the command by voice input, the Help window is displayed over the character. If the character is off-screen, the window is displayed on-screen nearest to the character's current position.

If the server returns dwCommandID as an empty string (""), it indicates that the user selected a server-supplied command.

This event is sent only to the client application that places the character into Help mode.

See Also

IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName, IAgentCharacterEx::SetHelpContextID, IAgentCommandsEx::SetHelpContextID