Edit

Share via

IAgentCharacterEx::GetHelpFileName

  • Article

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

HRESULT GetHelpFileName(
   BSTR * pbszName  // address of Help filename
);

Retrieves the HelpFileName for a character.

  • Returns S_OK to indicate the operation was successful.

pbszName

Address of a variable that receives the Help filename 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 clicks the character or selects a command from its pop-up menu. If there is a context number in the selected command's HelpContextID property, Help displays a topic corresponding to the current Help context; otherwise it displays "No Help topic associated with this item."

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.

Note

Building a Help file requires the Microsoft Windows Help Compiler.

 

See Also

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