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 属性,Microsoft代理会在 HelpModeOn 设置为 True 时自动调用帮助,并且用户选择 Command 对象。 如果 HelpContextID中存在上下文号,代理将调用帮助并搜索当前上下文编号标识的主题。 当前上下文号是 Command 对象的 HelpContextID 的值。

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

注意

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

 

另请参阅

IAgentCommandsEx::SetHelpContextIDIAgentCharacterEx::SetHelpModeOnIAgentCharacterEx::SetHelpFileName