IXpsOMPath::GetAccessibilityShortDescription-Methode (xpsobjectmodel.h)
Ruft die kurze Textbeschreibung des Objektinhalts ab. Diese Beschreibung 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 dieser Text nicht festgelegt wurde, wird ein NULL-Zeiger zurückgegeben.
Rückgabewert
Die Methode gibt ein HRESULT zurück. Mögliche Werte sind unter anderem diejenigen in der folgenden Tabelle. Informationen zu Rückgabewerten der XPS-Dokument-API, 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
Der wert, der in shortDescription zurückgegeben wird, ist der Wert des AutomationProperties.Name-Attributs des Path-Elements im Dokumentmarkup.
Diese Methode ordnet den Arbeitsspeicher zu, der von der Zeichenfolge verwendet wird, die in shortDescription zurückgegeben wird. Wenn shortDescription nicht NULL ist, verwenden Sie die CoTaskMemFree-Funktion , um den Arbeitsspeicher freizugeben.
Anforderungen
| Anforderung | Wert |
|---|---|
| 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 |