IUIAutomationStructureChangedEventHandler::HandleStructureChangedEvent method (uiautomationclient.h)

Article
06/28/2023

Handles an event that is raised when the Microsoft UI Automation tree structure has changed.

Syntax

HRESULT HandleStructureChangedEvent(
  [in] IUIAutomationElement *sender,
  [in] StructureChangeType  changeType,
  [in] SAFEARRAY            *runtimeId
);

Parameters

[in] sender

Type: IUIAutomationElement*

A pointer to the element that raised the event.

[in] changeType

Type: StructureChangeType

A value indicating the type of tree structure change that took place.

[in] runtimeId

Type: SAFEARRAY*

Receives the runtime identifier of the element. This parameter is used only when changeType is StructureChangeType_ChildRemoved; it is NULL for all other structure-change events.

Return value

Type: HRESULT

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

Remarks

This method is implemented by the application to handle events that it has subscribed to by using AddStructureChangedEventHandler

Adjusting an event handler from within this method is not supported.

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)

Share via