Compartir a través de

Método IXpsOMPath::GetAccessibilityLongDescription (xpsobjectmodel.h)

  • Artículo

Obtiene la descripción textual larga (detallada) del contenido del objeto. Los clientes de accesibilidad usan esta descripción para describir el objeto.

Sintaxis

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

Parámetros

[out, retval] longDescription

Descripción textual detallada del contenido del objeto. Si no se ha establecido este texto, se devolverá un puntero NULL .

Valor devuelto

El método devuelve un valor HRESULT. Entre los valores posibles se incluyen, entre otros, los de la tabla siguiente. Para obtener información sobre los valores devueltos de la API de documentos XPS que no aparecen en esta tabla, vea Errores del documento XPS.

Código devuelto Descripción
S_OK
 El método se ha llevado a cabo de forma correcta.
E_POINTER
 longDescription es NULL.

Comentarios

El valor devuelto en longDescription es el valor del atributo AutomationProperties.HelpText del elemento Path en el marcado de documento.

Este método asigna la memoria usada por la cadena que se devuelve en longDescription. Si longDescription no es NULL, use la función CoTaskMemFree para liberar la memoria.

Requisitos

Requisito Value
Cliente mínimo compatible Windows 7, Windows Vista con SP2 y Platform Update para Windows Vista [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible Windows Server 2008 R2, Windows Server 2008 con SP2 y Actualización de plataforma para Windows Server 2008 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino Windows
Encabezado xpsobjectmodel.h

Consulte también

IXpsOMPath

XML Paper Specification

Errores del documento XPS