GetClipBox

2.x

  int GetClipBox(hdc, lprc)    
  HDC hdc; /* handle of device context */
  RECT FAR* lprc; /* address of structure with rectangle */

The GetClipBox function retrieves the dimensions of the smallest rectangle that completely contains the current clipping region.

Parameters

hdc

Identifies the device context.

lprc

Points to the RECT structure that receives the logical coordinates of the rectangle. The RECT structure has the following form:

typedef struct tagRECT {    /* rc */
   int left;
   int top;
   int right;
   int bottom;
} RECT;

For a full description of this structure, see the Microsoft Windows Programmer's Reference, Volume 3.

Return Value

The return value is SIMPLEREGION (region has no overlapping borders), COMPLEXREGION (region has overlapping borders), or NULLREGION (region is empty), if the function is successful. Otherwise, the return value is ERROR.

See Also

GetBoundsRect, GetRgnBox, GetTextExtent, SelectClipRgn