Share via

TextRange_GetEnclosingElement Function

  • Article

Note  This function is deprecated. Client applications should use the Microsoft UI Automation COM interfaces instead.

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

Syntax

HRESULT TextRange_GetEnclosingElement(      
    HUIATEXTRANGE hobj,
    HUIANODE *pResult
);

Parameters

  • hobj
    [in] A text range object.
  • pResult
    [out] When this function returns, contains the node for the next smallest element that encloses the range. This parameter is passed uninitialized.

Return Value

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.

Function Information

Stock Implementation uiautomationcore.dll
Custom Implementation No
Header uiautomationcoreapi.h
Import library uiautomationcore.lib
Minimum operating systems Windows XP