Méthode IXpsOMCanvas ::GetAccessibilityLongDescription (xpsobjectmodel.h)
Obtient la description textuelle longue (détaillée) du contenu de l’objet. Ce texte est utilisé par les clients d’accessibilité pour décrire l’objet.
Syntaxe
HRESULT GetAccessibilityLongDescription(
[out, retval] LPWSTR *longDescription
);
Paramètres
[out, retval] longDescription
Description textuelle longue (détaillée) du contenu de l’objet. Un pointeur NULL est retourné si ce texte n’a pas été défini.
Valeur retournée
Cette méthode retourne un code HRESULT. Les valeurs possibles incluent, sans s’y limiter, celles de la table 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 |
|
longDescription a lavaleur NULL. |
Remarques
La propriété retournée par cette méthode correspond à l’attribut AutomationProperties.HelpText de l’élément Canvas 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 SignatureDefinitions 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 Mise à jour de plateforme pour Windows Server 2008 [applications de bureau | Applications UWP] |
| Plateforme cible | Windows |
| En-tête | xpsobjectmodel.h |