IAccessible：：get_accDescription 方法 (oleacc.h)

项目
02/29/2024

IAccessible：：get_accDescription 方法检索描述指定对象的视觉外观的字符串。并非所有对象都有说明。

注意Description 属性通常使用不当，Microsoft UI 自动化不支持。 Microsoft Active Accessibility 服务器开发人员不应使用此属性。如果辅助功能和自动化方案需要更多信息，请使用UI 自动化元素和控件模式支持的属性。

语法

HRESULT get_accDescription(
  [in]          VARIANT varChild,
  [out, retval] BSTR    *pszDescription
);

参数

[in] varChild

类型： VARIANT

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

[out, retval] pszDescription

类型： BSTR*

接收描述指定对象的本地化字符串的 BSTR 的地址;如果此对象没有说明，则为 NULL 。

返回值

类型： HRESULT

如果成功，则返回 S_OK。

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

返回代码	说明
S_FALSE	指定的对象没有说明。
E_INVALIDARG	自变量无效。
DISP_E_MEMBERNOTFOUND	指定的对象不支持此属性。

注解

Microsoft Active Accessibility 服务器可以通过使用直接注释、IAccessibleEx 接口或通过同时实现 Microsoft Active Accessibility 和 UI 自动化这两种处理WM_GETOBJECT消息的实现来添加对UI 自动化的支持。

此属性为用户提供对象的文本等效项。说明应类似于 HTML 中 ALT 属性提供的文本，该属性是显示的文本，用于描述使用纯文本浏览器的用户的图像。但是，某些控件使用此属性来存储与文本等效项无关的控件的额外信息。有关此属性的详细信息，请参阅说明属性。

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

服务器示例

以下示例代码演示了一个可能实现此方法的自定义列表框，该列表框维护其自己的子元素。该示例演示了语法，但请记住，仅实际文本列表框可能不需要支持此属性。为简单起见，示例中的字符串未本地化。


HRESULT STDMETHODCALLTYPE AccServer::get_accDescription( 
    VARIANT varChild,
    BSTR *pszDescription)
{
    if (varChild.vt != VT_I4)
    {
        *pszDescription = NULL;
        return E_INVALIDARG;
    }
    if (varChild.lVal == CHILDID_SELF)
    {
        *pszDescription = SysAllocString(L"List of contacts.");    
            
    }
    else
    {
        *pszDescription = SysAllocString(L"A contact.");           
            
    }
    return S_OK;
};

客户端示例

以下示例函数检索指定辅助对象或子元素的说明，并将其显示在主机上。


HRESULT PrintDescription(IAccessible* pAcc, long child)
{
    VARIANT varObject;
    varObject.vt = VT_I4;
    varObject.lVal = child;
    BSTR bstrDesc;
    HRESULT hr = pAcc->get_accDescription(varObject, &bstrDesc);
    if (hr == S_OK)
    {
        printf("Description: %S\n", bstrDesc);
        SysFreeString(bstrDesc);
    }
    return hr;
}

要求

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