IXpsOMCanvas::GetAccessibilityShortDescription-Methode (xpsobjectmodel.h)
Ruft eine kurze Textbeschreibung des Objektinhalts ab. Dieser Text wird von Barrierefreiheitsclients verwendet, um das Objekt zu beschreiben.
Syntax
HRESULT GetAccessibilityShortDescription(
[out, retval] LPWSTR *shortDescription
);
Parameter
[out, retval] shortDescription
Die kurze Textbeschreibung des Objektinhalts. Wenn diese Beschreibung nicht festgelegt ist, wird ein NULL-Zeiger zurückgegeben.
Rückgabewert
Die Methode gibt ein HRESULT zurück. Mögliche Werte sind unter anderem die Werte in der folgenden Tabelle. Informationen zu XPS-Dokument-API-Rückgabewerten, die in dieser Tabelle nicht aufgeführt sind, finden Sie unter XPS-Dokumentfehler.
| Rückgabecode | Beschreibung |
|---|---|
|
Die Methode wurde erfolgreich ausgeführt. |
|
shortDescription ist NULL. |
Hinweise
Die von dieser Methode zurückgegebene Eigenschaft entspricht dem AutomationProperties.Name-Attribut des Canvas-Elements im Dokumentmarkup.
Diese Methode ordnet den Arbeitsspeicher zu, der von der zurückgegebenen Zeichenfolge verwendet wird. Wenn shortDescription nicht NULL ist, verwenden Sie die CoTaskMemFree-Funktion , um den Arbeitsspeicher freizugeben.
Anforderungen
| Unterstützte Mindestversion (Client) | Windows 7, Windows Vista mit SP2 und Plattformupdate für Windows Vista [Desktop-Apps | UWP-Apps] |
| Unterstützte Mindestversion (Server) | Windows Server 2008 R2, Windows Server 2008 mit SP2 und Plattformupdate für Windows Server 2008 [Desktop-Apps | UWP-Apps] |
| Zielplattform | Windows |
| Kopfzeile | xpsobjectmodel.h |