Edit

Share via

IAgentCharacterEx::GetHelpModeOn

  • Article

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

HRESULT GetHelpModeOn(
   long * pbHelpModeOn  // address of help mode setting
);

Retrieves whether context-sensitive Help mode is on for the character.

  • Returns S_OK to indicate the operation was successful.

pbHelpModeOn

Address of a variable that receives True if Help mode is on for the character and False if not.

When this property is set to True, the mouse pointer changes to the context-sensitive Help image when moved over the character or over the pop-up menu for the character. When the user clicks or drags the character or clicks an item in the character's pop-up menu, the server triggers the IAgentNotifySinkEx::HelpComplete event and exits Help mode.

In Help mode, the server does not send the IAgentNotifySink::Click, IAgentNotifySink::DragStart, IAgentNotifySink::DragComplete, and IAgentNotifySink::Command events, unless GetAutoPopupMenu property returns True. In that case, the server will send the IAgentNotifySink::Click event (does not exit Help mode), but only for the right mouse button to enable you to display the pop-up menu.

This property applies only to your client application's use of the character; the setting does not affect other clients of the character or other characters of your client application.

See Also

IAgentCharacterEx::SetHelpModeOn