Share via

TextPattern_GetVisibleRanges Function

  • Article

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

Retrieves an array of disjoint text ranges from a text container where each text range begins with the first partially visible line through to the end of the last partially visible line. For example, a multi-column layout where the columns are partially scrolled out of the visible area of the viewport and the content flows from the bottom of one column to the top of the next.

Syntax

HRESULT TextPattern_GetVisibleRanges(      
    HUIAPATTERNOBJECT hobj,
    HUIATEXTRANGE *pRetVal
);

Parameters

  • hobj
    [in] A control pattern object.
  • pRetVal
    [out] When this function returns, contains an array of text ranges spanning the visible text within the text container. This parameter is passed uninitialized.

Return Value

Returns S_OK if successful or an error value otherwise.

Function Information

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