IAgentCharacterEx::GetHelpFileName

[Microsoft 代理从 Windows 7 开始已弃用,可能在后续版本的 Windows 中不可用。]

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

检索字符的 HelpFileName。

  • 返回指示操作成功的S_OK。

pbszName

接收字符的帮助文件名的变量的地址。

如果已为应用程序创建了 Windows 帮助文件并设置了字符的 HelpFile 属性,则当 HelpModeOn 设置为 True 并且用户单击该字符或从其弹出菜单中选择命令时,Microsoft 代理会自动调用帮助。 如果所选命令的 HelpContextID 属性中存在上下文编号,则帮助将显示与当前帮助上下文对应的主题;否则会显示“没有与此项目关联的帮助主题”。

此属性仅适用于客户端应用程序对 字符的使用;设置不会影响客户端应用程序的字符或其他字符的其他客户端。

注意

生成帮助文件需要 Microsoft Windows 帮助编译器。

 

另请参阅

IAgentCommandsEx::SetHelpContextIDIAgentCharacterEx::SetHelpModeOnIAgentCharacterEx::SetHelpFileName