TextPattern_RangeFromChild function

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(
  HUIAPATTERNOBJECT hobj,
  HUIANODE          hnodeChild,
  HUIATEXTRANGE     *pRetVal
);

Parameters

hobj

Type: HUIAPATTERNOBJECT

A control pattern object.

hnodeChild

Type: HUIANODE

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

pRetVal

Type: HUIATEXTRANGE*

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

Return Value

Type: HRESULT

Returns S_OK if successful or an error value otherwise.

Remarks

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.

Requirements

   
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