Поделиться через

Метод IXpsOMCanvas::GetAccessibilityShortDescription (xpsobjectmodel.h)

  • Статья

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

Синтаксис

HRESULT GetAccessibilityShortDescription(
  [out, retval] LPWSTR *shortDescription
);

Параметры

[out, retval] shortDescription

Краткое текстовое описание содержимого объекта. Если это описание не задано, возвращается указатель NULL .

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

Метод возвращает HRESULT. Возможные значения включают, помимо прочего, значения в следующей таблице. Сведения о возвращаемых значениях API документов XPS, не перечисленных в этой таблице, см. в разделе Ошибки документа XPS.

Код возврата Описание
S_OK
 Метод выполнен успешно.
E_POINTER
 ShortDescription имеет значение NULL.

Комментарии

Свойство, возвращаемое этим методом, соответствует атрибуту AutomationProperties.Name элемента Canvas в разметке документа.

Этот метод выделяет память, используемую строкой, возвращаемой в shortDescription. Если свойство shortDescription не равно NULL, используйте функцию CoTaskMemFree, чтобы освободить память.

Требования

   
Минимальная версия клиента Windows 7, Windows Vista с пакетом обновления 2 (SP2) и обновление платформы для Windows Vista [классические приложения | Приложения UWP]
Минимальная версия сервера Windows Server 2008 R2, Windows Server 2008 с пакетом обновления 2 (SP2) и Обновление платформы для Windows Server 2008 [классические приложения | Приложения UWP]
Целевая платформа Windows
Header xpsobjectmodel.h

См. также раздел

IXpsOMCanvas

XPS

Ошибки документа XPS