Metodo IXpsOMCanvas::GetAccessibilityLongDescription (xpsobjectmodel.h)

Ottiene la descrizione testuale lunga (dettagliata) del contenuto dell'oggetto. Questo testo viene usato dai client di accessibilità per descrivere l'oggetto.

Sintassi

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

Parametri

[out, retval] longDescription

Descrizione testuale lunga (dettagliata) del contenuto dell'oggetto. Se questo testo non è stato impostato, viene restituito un puntatore NULL .

Valore restituito

Il metodo restituisce un HRESULT. I valori possibili includono, ma non sono limitati a quelli della tabella che segue. Per informazioni sui valori restituiti dall'API documento XPS non elencati in questa tabella, vedere Errori del documento XPS.

Codice restituito	Descrizione
S_OK	Il metodo è riuscito.
E_POINTER	longDescription è NULL.

Commenti

La proprietà restituita da questo metodo corrisponde all'attributo AutomationProperties.HelpText dell'elemento Canvas nel markup del documento.

Questo metodo alloca la memoria utilizzata dalla stringa restituita in longDescription. Se longDescription non è NULL, usare la funzione SignatureDefinitions per liberare la memoria.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 7, Windows Vista con SP2 e Aggiornamento della piattaforma per Windows Vista [app desktop | App UWP]
Server minimo supportato	Windows Server 2008 R2, Windows Server 2008 con SP2 e Platform Update per Windows Server 2008 [app desktop | App UWP]
Piattaforma di destinazione	Windows
Intestazione	xpsobjectmodel.h

Vedi anche

IXpsOMCanvas

XML Paper Specification

Errori del documento XPS