Share via

ITextRangeProvider::GetBoundingRectangles Method

  • Article

Retrieves a collection of bounding rectangles for each fully or partially visible line of text in a text range.

Syntax

HRESULT GetBoundingRectangles(      
    SAFEARRAY **pRetVal
);

Parameters

  • pRetVal
    [out, retval] The address of a variable that receives a pointer to a SAFEARRAY that contains one of the following.

    • An array of bounding rectangles for each full or partial line of text in a text range.
    • An empty array for a degenerate range.
    • An empty array for a text range that has screen coordinates placing it completely off-screen, scrolled out of view, or obscured by an overlapping window.

    This parameter is passed uninitialized.

Return Value

Returns S_OK if successful, or an error value otherwise.

See Also

UI Automation Providers Overview, ITextProvider, Working with Safe Arrays