IUIAutomationTextRange3::GetChildrenBuildCache method (uiautomationclient.h)

Article
02/22/2024

Returns the children and supplied properties and patterns for elements in a text range in a single cross-process call. This is equivalent to calling GetChildren, but adds the standard build cache pattern.

Syntax

HRESULT GetChildrenBuildCache(
  [in]          IUIAutomationCacheRequest *cacheRequest,
  [out, retval] IUIAutomationElementArray **children
);

Parameters

[in] cacheRequest

An IUIAutomationCacheRequest specifying the properties and control patterns to be cached.

[out, retval] children

Returns the children, and each child’s properties or patterns, of the text range that meet the criteria of the supplied cacheRequest.

Return value

Returns S_OK if successful, otherwise an HRESULT error code.

Remarks

Following the design of GetChildren:

Children that overlap with the text range, but are not entirely enclosed by it will also be included.
When no children exist, an empty collection is returned.

As a result of a successful call, UI Automation clients are able call "Cached" APIs of IUIAutomationElement that are provided in the cacheRequest, for example, IUIAutomationElement::GetCachedPropertyValue.

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 1703 [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	uiautomationclient.h (include UIAutomation.h)