Edit

Share via

IUIAutomationEventHandlerGroup::AddPropertyChangedEventHandler method (uiautomationclient.h)

  • Article

Registers a method that handles a property-changed event.

Important  Microsoft UI Automation clients should use the handler group methods to register event listeners instead of individual event registration methods defined in the various IUIAutomation namespaces.
 

Syntax

HRESULT AddPropertyChangedEventHandler(
  [in] TreeScope                                scope,
  [in] IUIAutomationCacheRequest                *cacheRequest,
  [in] IUIAutomationPropertyChangedEventHandler *handler,
  [in] PROPERTYID                               *propertyArray,
       int                                      propertyCount
);

Parameters

[in] scope

The scope of events to be handled; that is, whether they are on the element itself, or on its ancestors and children.

[in] cacheRequest

A pointer to a cache request, or NULL if no caching is wanted.

[in] handler

A pointer to the object that handles the event.

[in] propertyArray

A pointer to the UI Automation properties of interest. For a list of property IDs, see Property Identifiers.

propertyCount

The number of properties being monitored.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Before implementing an event handler, you should be familiar with the threading issues described in Understanding Threading Issues.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1809 [desktop apps only]
Minimum supported server Windows Server, version 1709 [desktop apps only]
Target Platform Windows
Header uiautomationclient.h (include UIAutomation.h)

See also

IUIAutomationEventHandlerGroup