IAgentCharacterEx::SetHelpModeOn

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

HRESULT SetHelpModeOn(
   long bHelpModeOn  // help mode setting
);

Sets context-sensitive Help mode on for the character.

• Returns S_OK to indicate the operation was successful.

bHelpModeOn

Help mode flag. If this parameter is True, Microsoft Agent turns on Help mode for the character.

When you set this property 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 Click, DragStart, DragComplete, and Command events, unless the GetAutoPopupMenu property returns True. In that case, the server will send the Click event (does not exit Help mode), but only for the right mouse button so you can 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::GetHelpModeOn, IAgentNotifySinkEx::HelpComplete