GetRgnBox

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
Yes
Import Library
gdi32.lib
Header File
wingdi.h
Unicode
No
Platform Notes
Windows 95: int == 16 bits

The GetRgnBox function retrieves the bounding rectangle of the specified region.

int GetRgnBox(

HRGN hrgn,	// handle of a region
LPRECT lprc	// address of structure that receives bounding rect.
);

Parameters
hrgn

Identifies the region.

lprc

Points to a RECT structure that receives the bounding rectangle.

Return Values
The return value specifies the region's complexity. It can be one of the following values:

Value	Meaning
NULLREGION	Region is empty.
SIMPLEREGION	Region is a single rectangle.
COMPLEXREGION	Region is more than a single rectangle.

If the hrgn parameter does not identify a valid region, the return value is zero.