IHTMLTextRangeMetrics2::getClientRects Method

Retrieves a collection of rectangles that describe the layout of the contents of an object or range within the client. Each rectangle describes a single line.

Syntax

HRESULT getClientRects(
    IHTMLRectCollection **pRectCol
);

Parameters

pRectCol

Address of a pointer to an IHTMLRectCollection interface that returns a TextRectangle collection, with each rectangle in the collection having four integer properties.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

The pRectCol parameter has properties such as top, left, right, and bottom. Each property represents a coordinate of the rectangle, in pixels.