IUIAutomationTreeWalker::GetParentElementBuildCache method (uiautomationclient.h)

Article
02/22/2024

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

Syntax

HRESULT GetParentElementBuildCache(
  [in]          IUIAutomationElement      *element,
  [in]          IUIAutomationCacheRequest *cacheRequest,
  [out, retval] IUIAutomationElement      **parent
);

Parameters

[in] element

Type: IUIAutomationElement*

A pointer to the element for which to retrieve the parent.

[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] parent

Type: IUIAutomationElement**

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

Return value

Type: HRESULT

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

Remarks

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 parent element will be returned as the parent 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