IAgentCommandEx::GetHelpContextID

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

HRESULT GetHelpContextID(
   long * pulID  //  address of command's help topic ID
);

Retrieves the HelpContextID for a Command object.

• Returns S_OK to indicate the operation was successful.

pulID

Address of a variable that receives the context number of the help topic associated with the Command object.

If you've created a Windows Help file for your application and set your character's HelpFile property to this file, 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.

See Also

IAgentCommandEx::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName