UiaRaiseStructureChangedEvent function

Called by a provider to notify the Microsoft UI Automation core that the tree structure has changed.

Syntax


HRESULT WINAPI UiaRaiseStructureChangedEvent(
  _In_ IRawElementProviderSimple *pProvider,
  _In_ StructureChangeType       structureChangeType,
  _In_ int                       *pRuntimeId,
  _In_ int                       cRuntimeIdLen
);

Parameters

pProvider [in]

Type: IRawElementProviderSimple*

The provider node where the tree change occurred.

structureChangeType [in]

Type: StructureChangeType

The type of change that occurred in the tree.

pRuntimeId [in]

Type: int*

The runtime IDs for the child elements of the provider node where the tree change occurred. This parameter is used only when structureChangeType is StructureChangeType_ChildRemoved; it is NULL for all other structure-change events.

Note  For Windows 7, the array of integers pointed to by pRuntimeId can contain a partial set of IDs that identify only those elements affected by the structure change.
 
cRuntimeIdLen [in]

Type: int

Length of the array of integers.

Return value

Type: HRESULT

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

Remarks

An example of a change in the tree structure is child elements being added to or removed from a list box, or being expanded or collapsed in a tree view.

Requirements

Minimum supported client

Windows XP [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2003 [desktop apps | Windows Store apps]

Header

UIAutomationCoreApi.h

Library

Uiautomationcore.lib

DLL

Uiautomationcore.dll

 

 

Show: