IAgentCommandsEx::GetHelpContextID

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

HRESULT GetHelpContextID(
   long * pulHelpID  // address of Commands object help topic ID
);

Retrieves the HelpContextID for a Command object.

• Returns S_OK to indicate the operation was successful.

pulHelpID

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

If you've created a Windows Help file for your application and set the character's HelpFile property, Microsoft Agent automatically calls Help when HelpModeOn is set to True and the user selects your Command object. 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 object.

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

IAgentCommandsEx::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName