TextPattern_RangeFromChild function (uiautomationcoreapi.h)

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

Gets the text range that a given node spans.

Syntax

HRESULT TextPattern_RangeFromChild(
  [in]  HUIAPATTERNOBJECT hobj,
  [in]  HUIANODE          hnodeChild,
  [out] HUIATEXTRANGE     *pRetVal
);

[in] hobj

Type: HUIAPATTERNOBJECT

A control pattern object.

[in] hnodeChild

Type: HUIANODE

Reference to a node that the client wants the text range for.

[out] pRetVal

Type: HUIATEXTRANGE*

When this function returns, contains the text range that the node spans. This parameter is passed uninitialized.

Type: HRESULT

Returns S_OK if successful or an error value otherwise.

As an example of how this function might be used, a client can pass in an embedded hyperlink control and receive the range of text that it spans.

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	uiautomationcoreapi.h
Library	Uiautomationcore.lib
DLL	Uiautomationcore.dll