GetRgnBox

GetRgnBox function

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

Syntax


int GetRgnBox(
  _In_  HRGN   hrgn,
  _Out_ LPRECT lprc
);

Parameters

hrgn [in]

A handle to the region.

lprc [out]

A pointer to a RECT structure that receives the bounding rectangle in logical units.

Return value

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

ValueMeaning
NULLREGIONRegion is empty.
SIMPLEREGIONRegion is a single rectangle.
COMPLEXREGIONRegion is more than a single rectangle.

 

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

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Wingdi.h (include Windows.h)

Library

Gdi32.lib

DLL

Gdi32.dll

See also

Regions Overview
Region Functions
RECT

 

 

Community Additions

ADD
Show:
© 2016 Microsoft