IAgentCharacterEx::GetHelpFileName

[自 Windows 7 起弃用 Microsoft 代理,在后续版本的 Windows 中可能不可用。

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

检索字符的 HelpFileName。

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

pbszName

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

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

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

注意

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

 

另请参阅

IAgentCommandsEx::SetHelpContextIDIAgentCharacterEx::SetHelpModeOnIAgentCharacterEx::SetHelpFileName