IAgentCharacterEx::SetHelpContextID

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

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

设置字符的 HelpContextID

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

ulHelpID

与字符关联的帮助主题的上下文编号;用于为字符提供上下文相关帮助。

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

仅当客户端应用程序是最顶层字符的活动客户端时,此设置才适用。 它不会影响客户端应用程序正在使用的字符或其他字符的其他客户端。

注意

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

 

另请参阅

IAgentCharacterEx::GetHelpContextIDIAgentCharacterEx::SetHelpModeOnIAgentCharacterEx::SetHelpFileName