IAgentCharacterEx::GetHelpContextID
[Microsoft 代理从 Windows 7 开始已弃用,可能在后续版本的 Windows 中不可用。]
HRESULT GetHelpContextID(
long * pulHelpID // address of character's help topic ID
);
检索字符的 HelpContextID 。
- 返回指示操作成功的S_OK。
-
pulHelpID
-
接收字符帮助主题的上下文编号的变量的地址。
如果已为应用程序创建了 Windows 帮助文件并设置了字符的 HelpFile 属性,则当 HelpModeOn 设置为 True 并且用户选择字符时,Microsoft 代理会自动调用帮助。 如果 HelpContextID 中存在上下文编号,则代理将调用“帮助”并搜索由当前上下文编号标识的主题。 当前上下文编号是字符的 HelpContextID 值。
IAgentCharacterEx::GetHelpContextID 返回为字符设置的 HelpContextID 。 它不返回由其他客户端设置的 HelpContextID 。
注意
生成帮助文件需要 Microsoft Windows 帮助编译器。
另请参阅
IAgentCharacterEx::SetHelpContextID、 IAgentCharacterEx::SetHelpModeOn、 IAgentCharacterEx::SetHelpFileName