UiaAddEvent-Funktion (uiautomationcoreapi.h)

Artikel
08/26/2023

Hinweis Diese Funktion ist veraltet. Clientanwendungen sollten stattdessen die COM-Schnittstellen (Component Object Model) von Microsoft UI Automation verwenden.

Fügt einen Listener für Ereignisse auf einem Knoten in der Ui Automation-Struktur hinzu.

Syntax

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
);

Parameter

[in] hnode

Typ: HUIANODE

Der Knoten, dem ein Ereignislistener hinzugefügt werden soll.

[in] eventId

Typ: EVENTID

Der Bezeichner des zu lauschenden Ereignisses. Eine Liste der Ereignis-IDs finden Sie unter Ereignisbezeichner.

[in] pCallback

Typ: UiaEventCallback*

Die Adresse der anwendungsdefinierte UiaEventCallback-Rückruffunktion , die aufgerufen wird, wenn das Ereignis ausgelöst wird.

[in] scope

Typ: TreeScope*

Ein Wert aus dem TreeScope-enumerierten Typ, der den Bereich der zu behandelnden Ereignisse angibt; d. h. unabhängig davon, ob sie sich auf dem Element selbst oder auf seinen Vorgängern und untergeordneten Elementen befinden.

[in] pProperties

Typ: PROPERTYID*

Die Adresse eines Arrays, das die Bezeichner der eigenschaften enthält, die auf Änderungsereignisse überwacht werden sollen, wenn eventId die von AutomationPropertyChanged_Event_GUID abgeleitete EVENTID ist; andernfalls ist dieser Parameter NULL. Eine Liste der Eigenschaften-IDs finden Sie unter Eigenschaftenbezeichner.

[in] cProperties

Typ: int

Die Anzahl der Elemente im pProperties-Array .

[in] pRequest

Typ: UiaCacheRequest*

Die Adresse einer UiaCacheRequest-Struktur , die die Cacheanforderung definiert, die für Knoten wirksam ist, die mit Ereignissen zurückgegeben werden.

[out] phEvent

Typ: HUIEVENT*

Wenn diese Funktion zurückgibt, enthält einen Zeiger auf das hinzugefügte Ereignis. Dieser Parameter wird nicht initialisiert übergeben.

Rückgabewert

Typ: HRESULT

Gibt S_OK zurück, wenn erfolgreich oder andernfalls ein Fehlerwert vorhanden ist.

Anforderungen


Unterstützte Mindestversion (Client)	Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	uiautomationcoreapi.h
Bibliothek	Uiautomationcore.lib
DLL	Uiautomationcore.dll

Weitere Informationen

UiaLookupId

Freigeben über