Edit

Share via

IAgentCommandEx::SetHelpContextID

  • Article

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

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

Sets the HelpContextID for a Command object.

  • Returns S_OK to indicate the operation was successful.

ulID

The context number of the help topic associated with the Command object; used to provide context-sensitive Help for the command.

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 command. 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 command.

Note

Building a Help file requires the Microsoft Windows Help Compiler.

 

See Also

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