Partager via


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

Obtient la description textuelle longue (détaillée) du contenu de l’objet. Cette description est utilisée par les clients d’accessibilité pour décrire l’objet .

Syntaxe

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

Paramètres

[out, retval] longDescription

Description textuelle détaillée du contenu de l’objet. Si ce texte n’a pas été défini, un pointeur NULL est retourné.

Valeur retournée

Cette méthode retourne un code HRESULT. Les valeurs possibles incluent, sans s’y limiter, celles du tableau qui suit. Pour plus d’informations sur les valeurs de retour de l’API de document XPS qui ne sont pas répertoriées dans ce tableau, consultez Erreurs de document XPS.

Code de retour Description
S_OK
S_OK
E_POINTER
longDescription a la valeur NULL.

Remarques

La valeur retournée dans longDescription est la valeur de l’attribut AutomationProperties.HelpText de l’élément Path dans le balisage du document.

Cette méthode alloue la mémoire utilisée par la chaîne retournée dans longDescription. Si longDescription n’a pas la valeur NULL, utilisez la fonction CoTaskMemFree pour libérer la mémoire.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 7, Windows Vista avec SP2 et Mise à jour de plateforme pour Windows Vista [applications de bureau | Applications UWP]
Serveur minimal pris en charge Windows Server 2008 R2, Windows Server 2008 avec SP2 et Platform Update pour Windows Server 2008 [applications de bureau | Applications UWP]
Plateforme cible Windows
En-tête xpsobjectmodel.h

Voir aussi

IXpsOMPath

XML Paper Specification

Erreurs de document XPS