This topic has not yet been rated - Rate this topic

GetRgnBox function

Applies to: desktop apps only

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

Minimum supported server

Windows 2000 Server

Header

Wingdi.h (include Windows.h)

Library

Gdi32.lib

DLL

Gdi32.dll

See also

Regions Overview
Region Functions
RECT

 

 

Send comments about this topic to Microsoft

Build date: 3/7/2012

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ