IAccessible::get_accHelpTopic 方法 (oleacc.h)
IAccessible::get_accHelpTopic 方法检索与指定对象关联的 WinHelp 文件的完整路径;它还检索该文件中相应主题的标识符。 并非所有对象都支持此属性。 应用程序很少支持或使用此属性
语法
HRESULT get_accHelpTopic(
[out] BSTR *pszHelpFile,
[in] VARIANT varChild,
long *pidTopic
);
参数
[out] pszHelpFile
类型: BSTR*
接收与指定对象关联的 WinHelp 文件的完整路径的 BSTR 的地址。
[in] varChild
类型: VARIANT
指定检索到的帮助主题是属于 对象还是对象的子元素之一。 此参数是获取对象) 帮助主题CHILDID_SELF (,也可以是子 ID (以获取对象的某个子元素的帮助主题) 。 有关初始化 VARIANT 的详细信息,请参阅 如何在参数中使用子 ID。
pidTopic
类型: long*
[out, retval]标识与指定对象关联的帮助文件主题的变量的地址。 此值用作传递给 WinHelp 函数的所需主题的上下文标识符。 调用 WinHelp 以显示主题时,请将 uCommand 参数设置为 HELP_CONTEXT,将 pidTopic 指向的值强制转换为 DWORD,并将其作为 dwData 参数传递。
返回值
类型: HRESULT
如果成功,则返回 S_OK。
如果未成功,则返回下表中的值之一或另一个标准 COM 错误代码。 服务器返回这些值,但客户端必须始终检查输出参数,以确保它们包含有效值。 有关详细信息,请参阅 检查 I 可访问的返回值。
错误 | 说明 |
---|---|
|
没有可用的帮助信息。 |
|
自变量无效。 |
|
对象不支持此属性。 |
注解
从帮助文件中获取信息可能占用大量时间和内存。
服务器开发人员注意: 此属性提供对 WinHelp 中帮助主题的访问权限,而 IAccessible::get_accHelp 返回字符串。 对象不需要同时支持 IAccessible::get_accHelp 和 IAccessible::get_accHelpTopic,但它们必须至少支持一个。 如果他们可以轻松返回字符串,则必须支持 IAccessible::get_accHelp;否则,它们必须支持 IAccessible::get_accHelpTopic。 如果两者都受支持, 则 IAccessible::get_accHelpTopic 会提供更多详细信息。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows 2000 Professional [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2003 [仅限桌面应用] |
目标平台 | Windows |
标头 | oleacc.h |
Library | Oleacc.lib |
DLL | Oleacc.dll |
可再发行组件 | 具有 SP6 及更高版本和 Windows 95 的 Windows NT 4.0 上的活动辅助功能 1.3 RDK |