Edit

Share via

IAgentCharacterEx::GetHelpContextID

  • Article

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

HRESULT GetHelpContextID(
   long * pulHelpID  // address of character's help topic ID
);

Retrieves the HelpContextID for the character.

  • 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 character.

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

IAgentCharacterEx::GetHelpContextID returns the HelpContextID you set for the character. It does not return the HelpContextID set by other clients.

Note

Building a Help file requires the Microsoft Windows Help Compiler.

 

See Also

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