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

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

  • Статья

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

Синтаксис

HRESULT GetAccessibilityLongDescription(
  [out, retval] LPWSTR *longDescription
);

Параметры

[out, retval] longDescription

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

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

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

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

Комментарии

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

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

Требования

Требование Значение
Минимальная версия клиента 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