Método IXpsOMCanvas::GetAccessibilityShortDescription (xpsobjectmodel.h)
Obtiene una breve descripción textual del contenido del objeto. Los clientes de accesibilidad usan este texto para describir el objeto.
Sintaxis
HRESULT GetAccessibilityShortDescription(
[out, retval] LPWSTR *shortDescription
);
Parámetros
[out, retval] shortDescription
Descripción textual breve del contenido del objeto. Si no se establece esta descripción, se devuelve 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 |
|---|---|
|
El método se ha llevado a cabo de forma correcta. |
|
shortDescription es NULL. |
Comentarios
La propiedad devuelta por este método corresponde al atributo AutomationProperties.Name del elemento Canvas en el marcado de documento.
Este método asigna la memoria usada por la cadena que se devuelve en shortDescription. Si shortDescription no es NULL, use la función CoTaskMemFree para liberar la memoria.
Requisitos
| 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 |