Метод IAccessible::get_accDescription (oleacc.h)

Статья
08/25/2023

Метод IAccessible::get_accDescription извлекает строку, описывающую внешний вид указанного объекта. Не все объекты имеют описание.

Примечание Свойство Description часто используется неправильно и не поддерживается microsoft модель автоматизации пользовательского интерфейса. Разработчики серверов Microsoft Active Accessibility не должны использовать это свойство. Если для сценариев со специальными возможностями и автоматизацией требуются дополнительные сведения, используйте свойства, поддерживаемые модель автоматизации пользовательского интерфейса элементами и шаблонами элементов управления.

Синтаксис

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

Параметры

[in] varChild

Тип: VARIANT

Указывает, принадлежит ли полученное описание объекту или одному из дочерних элементов объекта. Этот параметр является либо CHILDID_SELF (для получения сведений об объекте), либо идентификатор дочернего элемента (для получения сведений о дочернем элементе объекта). Дополнительные сведения об инициализации структуры VARIANT см. в разделе Использование идентификаторов дочерних элементов в параметрах.

[out, retval] pszDescription

Тип: BSTR*

Адрес BSTR , получающий локализованную строку, описывающую указанный объект, или значение NULL , если этот объект не имеет описания.

Возвращаемое значение

Тип: HRESULT

Возвращает значение S_OK, если операция завершилась успешно.

В случае успеха возвращает одно из значений в следующей таблице или другой стандартный код ошибки COM. Серверы возвращают эти значения, но клиенты должны всегда проверка выходные параметры, чтобы убедиться, что они содержат допустимые значения. Дополнительные сведения см. в разделе Проверка возвращаемых значений IAccessible.

Код возврата	Описание
S_FALSE	Указанный объект не имеет описания.
E_INVALIDARG	Аргумент является недопустимым.
DISP_E_MEMBERNOTFOUND	Указанный объект не поддерживает это свойство.

Сервер Microsoft Active Accessibility может добавить поддержку модель автоматизации пользовательского интерфейса с помощью прямой заметки, интерфейса IAccessibleEx или реализации Microsoft Active Accessibility и модель автоматизации пользовательского интерфейса параллельно с обоими реализации, обрабатывая сообщение WM_GETOBJECT.

Это свойство предоставляет пользователю текстовый эквивалент объекта . Описание должно быть похоже на текст, предоставленный с атрибутом ALT в HTML, который представляет собой текст, отображаемый для описания изображений для пользователей, использующих текстовые браузеры. Однако некоторые элементы управления используют это свойство для хранения дополнительных сведений об элементе управления, не связанном с текстовым эквивалентом. Дополнительные сведения об этом свойстве см. в разделе Свойство Description.

Обратите внимание на то, что разработчики серверов: Локализуйте строку, возвращаемую этим свойством.

Пример сервера

В следующем примере кода показана одна из возможных реализаций этого метода для настраиваемого списка, которое содержит собственные дочерние элементы. В примере демонстрируется синтаксис, но помните, что в реальном текстовом списке, вероятно, не потребуется поддерживать это свойство. Для простоты строки в примере не локализованы.


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
Header	oleacc.h
Библиотека	Oleacc.lib
DLL	Oleacc.dll
Распространяемые компоненты	Активные специальные возможности 1.3 RDK в Windows NT 4.0 с пакетом обновления 6 (SP6) и более поздних версий и Windows 95