IAgentCommandsEx：：SetHelpContextID

  • 项目

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

HRESULT SetHelpContextID(
   long ulHelpID  // ID for help topic
);

设置 Command 对象的 HelpContextID。

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

ulHelpID

与 Command 对象关联的帮助主题的上下文编号;用于为命令提供上下文相关的帮助。

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

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

注意

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

 

另请参阅

IAgentCommandsEx：：GetHelpContextID、 IAgentCharacterEx：：SetHelpModeOn、 IAgentCharacterEx：：SetHelpFileName