UiaNavigate, fonction (uiautomationcoreapi.h)

Article
03/03/2024

Note Cette fonction est déconseillée. Les applications clientes doivent utiliser les interfaces COM (Microsoft UI Automation Component Object Model) à la place.

Navigue dans l’arborescence UI Automation, récupérant éventuellement les informations mises en cache.

Syntaxe

HRESULT UiaNavigate(
  [in]  HUIANODE          hnode,
  [in]  NavigateDirection direction,
  [in]  UiaCondition      *pCondition,
  [in]  UiaCacheRequest   *pRequest,
  [out] SAFEARRAY         **ppRequestedData,
  [out] BSTR              *ppTreeStructure
);

Paramètres

[in] hnode

Type : HUIANODE

Élément sur lequel la navigation commence.

[in] direction

Type : NavigateDirection

Valeur du type énuméré NavigateDirection indiquant la direction à suivre pour naviguer à partir de hnode.

[in] pCondition

Type : UiaCondition*

Adresse d’une structure UiaCondition qui spécifie la condition à laquelle l’élément en cours de navigation doit correspondre. Utilisez ce paramètre pour ignorer les éléments qui ne sont pas d’intérêt.

[in] pRequest

Type : UiaCacheRequest*

Adresse d’une structure UiaCacheRequest qui contient une description des informations à mettre en cache.

[out] ppRequestedData

Type : SAFEARRAY**

Adresse d’une variable qui reçoit un pointeur vers un SAFEARRAY qui contient les données demandées. Ce paramètre est passé sans être initialisé. Consultez la section Notes.

[out] ppTreeStructure

Type : BSTR*

Adresse d’une variable qui reçoit la description de l’arborescence. Ce paramètre est passé sans être initialisé. Consultez la section Notes.

Valeur de retour

Type : HRESULT

Retourne S_OK en cas de réussite ou une valeur d’erreur dans le cas contraire.

Remarques

L’arborescence est décrite par une chaîne où chaque caractère est « p » ou « ». Le premier caractère de la chaîne représente toujours le nœud racine. La chaîne a la valeur NULL si aucun élément n’est retourné par la fonction.

Un « p » représente un nœud (élément UI Automation). Lorsqu’un « p » suit directement un autre, le deuxième nœud est un enfant du premier. Un « ) représente un pas en arrière dans l’arborescence. Par exemple, « pp)p » représente un nœud suivi de deux nœuds enfants frères les uns des autres. Dans « pp))p », le dernier nœud est un frère du premier.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	uiautomationcoreapi.h
Bibliothèque	Uiautomationcore.lib
DLL	Uiautomationcore.dll

Partager via