IAgentCommandsEx：：GetHelpContextID

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

HRESULT GetHelpContextID(
   long * pulHelpID  // address of Commands object help topic ID
);

检索 Command 对象的 HelpContextID。

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

pulHelpID

接收 Command 对象的帮助主题的上下文编号的变量的地址。

如果已为应用程序创建了 Windows 帮助文件并设置了字符的 HelpFile 属性，则当 HelpModeOn 设置为 True 并且用户选择 Command 对象时，Microsoft 代理会自动调用 帮助 。 如果 HelpContextID 中存在上下文编号，代理将调用帮助并搜索由当前上下文编号标识的主题。 当前上下文编号是 Command 对象的 HelpContextID 值。

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

注意

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

 

另请参阅

IAgentCommandsEx：：SetHelpContextID、 IAgentCharacterEx：：SetHelpModeOn、 IAgentCharacterEx：：SetHelpFileName