UiaAddEvent, fonction (uiautomationcoreapi.h)

Article
08/26/2023

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

Ajoute un écouteur pour les événements sur un nœud dans l’arborescence UI Automation.

Syntaxe

HRESULT UiaAddEvent(
  [in]  HUIANODE         hnode,
  [in]  EVENTID          eventId,
  [in]  UiaEventCallback *pCallback,
  [in]  TreeScope        scope,
  [in]  PROPERTYID       *pProperties,
  [in]  int              cProperties,
  [in]  UiaCacheRequest  *pRequest,
  [out] HUIAEVENT        *phEvent
);

Paramètres

[in] hnode

Type : HUIANODE

Nœud auquel ajouter un écouteur d’événements.

[in] eventId

Type : EVENTID

Identificateur de l’événement à écouter. Pour obtenir la liste des ID d’événement, consultez Identificateurs d’événements.

[in] pCallback

Type : UiaEventCallback*

Adresse de la fonction de rappel UiaEventCallback définie par l’application qui est appelée lorsque l’événement est déclenché.

[in] scope

Type : TreeScope*

Valeur du type énuméré TreeScope indiquant l’étendue des événements à gérer ; c’est-à-dire, qu’ils soient sur l’élément lui-même, ou sur ses ancêtres et ses enfants.

[in] pProperties

Type : PROPERTYID*

Adresse d’un tableau qui contient les identificateurs des propriétés pour surveiller les événements de modification, quand eventId est l’ID d’événement dérivé de AutomationPropertyChanged_Event_GUID ; sinon, ce paramètre a la valeur NULL. Pour obtenir la liste des ID de propriété, consultez Identificateurs de propriétés.

[in] cProperties

Type : int

Nombre d’éléments dans le tableau pProperties .

[in] pRequest

Type : UiaCacheRequest*

Adresse d’une structure UiaCacheRequest qui définit la demande de cache en vigueur pour les nœuds retournés avec des événements.

[out] phEvent

Type : HUIEVENT*

Lorsque cette fonction est retournée, contient un pointeur vers l’événement qui est ajouté. Ce paramètre est passé sans être initialisé.

Valeur retournée

Type : HRESULT

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

Configuration requise


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

Voir aussi

UiaLookupId

Share via