ITextRangeProvider::GetBoundingRectangles method
Retrieves a collection of bounding rectangles for each fully or partially visible line of text in a text range.
Syntax
HRESULT GetBoundingRectangles( [out, retval] SAFEARRAY **pRetVal );
Parameters
- pRetVal [out, retval]
-
Type: SAFEARRAY**
Receives a pointer to 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
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Requirements
|
Minimum supported client |
Windows XP [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
Windows Server 2003 [desktop apps | Windows Store apps] |
|
Header |
|
|
IDL |
|
See also
- Reference
- ITextProvider
- ITextRangeProvider
- Conceptual
- UI Automation Providers Overview
- Best Practices for Using Safe Arrays