IUIAutomation::AddAutomationEventHandler method (uiautomationclient.h)
Registers a method that handles Microsoft UI Automation events.
Syntax
HRESULT AddAutomationEventHandler(
[in] EVENTID eventId,
[in] IUIAutomationElement *element,
[in] TreeScope scope,
[in] IUIAutomationCacheRequest *cacheRequest,
[in] IUIAutomationEventHandler *handler
);
Parameters
[in] eventId
Type: EVENTID
The identifier of the event that the method handles. For a list of event IDs, see Event Identifiers.
[in] element
Type: IUIAutomationElement*
A pointer to the UI Automation element to associate with the event handler.
[in] scope
Type: TreeScope
The scope of events to be handled; that is, whether they are on the element itself, or on its ancestors and descendants.
[in] cacheRequest
Type: IUIAutomationCacheRequest*
A pointer to a cache request, or NULL if no caching is wanted.
[in] handler
Type: IUIAutomationEventHandler*
A pointer to the object that handles the event.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Remarks
A UI Automation client should not use multiple threads to add or remove event handlers. Unexpected behavior can result if one event handler is being added or removed while another is being added or removed in the same client process.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista, Windows XP with SP3 and Platform Update for Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008, Windows Server 2003 with SP2 and Platform Update for Windows Server 2008 [desktop apps only] |
| Target Platform | Windows |
| Header | uiautomationclient.h (include UIAutomation.h) |
See also
Caching UI Automation Properties and Control Patterns
Conceptual
Reference