IAccessible：：get_accHelp 方法 (oleacc.h)

项目
02/29/2024

IAccessible：：get_accHelp 方法检索对象的 Help 属性字符串。并非所有对象都支持此属性。

语法

HRESULT get_accHelp(
  [in]          VARIANT varChild,
  [out, retval] BSTR    *pszHelp
);

参数

[in] varChild

类型： VARIANT

指定检索到的帮助信息是属于对象还是对象的子元素之一。此参数CHILDID_SELF (获取有关对象) 的信息，或子 ID (获取有关对象子元素) 的信息。有关初始化 VARIANT 的详细信息，请参阅如何在参数中使用子 ID。

[out, retval] pszHelp

类型： BSTR*

接收包含指定对象的帮助信息的本地化字符串的 BSTR 的地址;如果没有可用的帮助信息，则为 NULL 。

返回值

类型： HRESULT

如果成功，则返回 S_OK。

如果未成功，则返回下表中的值之一或另一个标准 COM 错误代码。服务器返回这些值，但客户端必须始终检查输出参数，以确保它们包含有效值。有关详细信息，请参阅检查 I 可访问的返回值。

错误	说明
S_FALSE	没有可用的帮助信息。
E_INVALIDARG	自变量无效。
DISP_E_MEMBERNOTFOUND	对象不支持此属性。

注解

预定义的常用控件都不支持此属性。

服务器开发人员注意： 本地化从此属性返回的字符串。

此属性返回字符串，而 IAccessible：：get_accHelpTopic 提供对 WinHelp 中帮助主题的访问权限。对象不需要同时支持 IAccessible：：get_accHelp 和 IAccessible：：get_accHelpTopic，但它们必须至少支持一个。如果它们可以轻松返回字符串，则必须支持 IAccessible：：get_accHelp ;否则，它们必须支持 IAccessible：：get_accHelpTopic。如果两者都受支持， 则 IAccessible：：get_accHelpTopic 会提供更多详细信息。

服务器示例

以下示例代码演示了自定义列表框此方法的一种可能实现。根据列表中联系人的状态显示不同的文本。为简单起见，该示例未本地化返回的字符串。


// m_pControl is the custom control that returns this accessible object. 
// 'online' is an enumerated value. 

HRESULT STDMETHODCALLTYPE AccServer::get_accHelp( 
    VARIANT varChild,
    BSTR *pszHelp)
{
    *pszHelp = NULL;
    if (varChild.vt != VT_I4)
    {
        return E_INVALIDARG;
    }
    if (varChild.lVal == CHILDID_SELF)
    {
        *pszHelp = SysAllocString(L"Contact list.");
    }
    else
    {
        int index = (int)varChild.lVal - 1;
        CustomListControlItem* pItem = m_pControl->GetItemAt(index);
        if (pItem == NULL)
        {
            return E_INVALIDARG;
        }
        if (pItem->GetStatus() == online)
        {
            *pszHelp = SysAllocString(L"Online contact.");
        }
        else 
        {
            *pszHelp = SysAllocString(L"Offline contact.");
        }
    }
    return S_OK;
};

要求

要求	值
最低受支持的客户端	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