GetClipBox

The GetClipBox function retrieves the dimensions of the tightest bounding rectangle that can be drawn around the current visible area on the device. The visible area is defined by the current clipping region or clip path, as well as any overlapping windows. 

int GetClipBox(
  HDC hdc,      // handle of the device context
  LPRECT lprc   // address of structure with rectangle
);

Parameters

hdc
Handle to the device context.
lprc
Pointer to a RECT structure that is to receive the rectangle dimensions.

Return Values

If the function succeeds, the return value specifies the clipping box's complexity and can be any one of the following values:

Value Meaning
NULLREGION Region is empty.
SIMPLEREGION Region is a single rectangle.
COMPLEXREGION Region is more than one rectangle.
ERROR An error occurred.

GetClipBox returns logical coordinates based on the given device context.

Windows NT: To get extended error information, call GetLastError.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Requires version 1.0 or later.
  Header: Declared in wingdi.h.
  Import Library: Use gdi32.lib.

See Also

Clipping Overview, Clipping Functions, RECT