TextRange_GetEnclosingElement function

Note  This function is deprecated. Client applications should use the Microsoft UI Automation Component Object Model (COM) interfaces instead.
 

Returns the node for the next smallest provider that covers the range.

Syntax


HRESULT TextRange_GetEnclosingElement(
  _In_  HUIATEXTRANGE hobj,
  _Out_ HUIANODE      *pResult
);

Parameters

hobj [in]

Type: HUIATEXTRANGE

A text range object.

pResult [out]

Type: HUIANODE*

When this function returns, contains the node for the next smallest element that encloses the range. This parameter is passed uninitialized.

Return value

Type: HRESULT

Returns S_OK if successful or an error value otherwise.

Remarks

The enclosing element is typically the text provider that supplies the text range. However, if the text provider supports child elements such as tables or hyperlinks, the enclosing element could be a descendant of the text provider.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

UIAutomationCoreApi.h

Library

Uiautomationcore.lib

DLL

Uiautomationcore.dll

 

 

Show: