Export (0) Print
Expand All
Expand Minimize

IUIAutomation::AddStructureChangedEventHandler method

Registers a method that handles structure-changed events.

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

Syntax


HRESULT AddStructureChangedEventHandler(
  [in]  IUIAutomationElement *element,
  [in]  TreeScope scope,
  [in]  IUIAutomationCacheRequest *cacheRequest,
  [in]  IUIAutomationStructureChangedEventHandler *handler
);

Parameters

element [in]

Type: IUIAutomationElement*

A pointer to the UI Automation element associated with the event handler.

scope [in]

Type: TreeScope

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

cacheRequest [in]

Type: IUIAutomationCacheRequest*

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

handler [in]

Type: IUIAutomationStructureChangedEventHandler*

A pointer to the object that handles the structure-changed 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

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]

Header

UIAutomationClient.h (include UIAutomation.h)

IDL

UIAutomationClient.idl

See also

Reference
IUIAutomation
RemoveAllEventHandlers
RemoveStructureChangedEventHandler
Conceptual
Caching UI Automation Properties and Control Patterns
Subscribing to UI Automation Events
Understanding Threading Issues

 

 

Community Additions

ADD
Show:
© 2014 Microsoft