IUIAutomationTreeWalker::GetNextSiblingElementBuildCache method (uiautomationclient.h)

Article
02/22/2024

Retrieves the next sibling element of the specified UI Automation element, and caches properties and control patterns.

Syntax

HRESULT GetNextSiblingElementBuildCache(
  [in]          IUIAutomationElement      *element,
  [in]          IUIAutomationCacheRequest *cacheRequest,
  [out, retval] IUIAutomationElement      **next
);

Parameters

[in] element

Type: IUIAutomationElement*

A pointer to the element for which to retrieve the next sibling.

[in] cacheRequest

Type: IUIAutomationCacheRequest*

A pointer to a cache request that specifies the properties and control patterns to cache on the returned element.

[out, retval] next

Type: IUIAutomationElement**

Receives a pointer to the next sibling element, or NULL if there is no sibling element.

Return value

Type: HRESULT

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

Remarks

An element can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree.

The structure of the Microsoft UI Automation tree changes as the visible UI elements on the desktop change. It is not guaranteed that an element returned as the next sibling element will be returned as the next sibling on subsequent passes.

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