TextPattern_RangeFromPoint Function

  • Article

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

Retrieves the degenerate (empty) text range nearest to the specified screen coordinates.

Syntax

HRESULT TextPattern_RangeFromPoint(      
    HUIAPATTERNOBJECT hobj,
    HiaPoint point,
    HUIATEXTRANGE *pRetVal
);

Parameters

  • hobj
    [in] A control pattern object.
  • point
    [in] A UiaPoint structure that contains the location in screen coordinates.
  • pRetVal
    [out] When this function returns, contains the text range that the node spans. This parameter is passed uninitialized.

Return Value

Returns S_OK if successful or an error value otherwise.

Remarks

A text range that wraps a child object is returned if the screen coordinates are within the coordinates of an image, hyperlink, Microsoft Excel spreadsheet, or other embedded object.

Because hidden text is not ignored, this method retrieves a degenerate range from the visible text closest to the specified coordinates.

Function Information

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