Edit

Share via

IAgentCharacterEx::SetHelpContextID

  • Article

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

HRESULT SetHelpContextID(
   long ulHelpID  // ID for help topic
);

Sets the HelpContextID for the character.

  • Returns S_OK to indicate the operation was successful.

ulHelpID

The context number of the help topic for associated with a character; used to provide context-sensitive Help for the character.

If you've created a Windows Help file for your application and set this in the character's HelpFile property, Microsoft Agent automatically calls Help when HelpModeOn is set to True and the user selects the character. If there is a context number in the HelpContextID, Agent calls Help and searches for the topic identified by the current context number. The current context number is the value of HelpContextID for the character. If there is a context number in the HelpContextID property, Help displays a topic corresponding to the current Help context; otherwise it displays "No Help topic associated with this item."

This setting applies only when your client application is the active client of the topmost character. It does not affect other clients of the character or other characters that your client application is using.

Note

Building a Help file requires the Microsoft Windows Help Compiler.

 

See Also

IAgentCharacterEx::GetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName