ExcludeClipRect

The ExcludeClipRect function creates a new clipping region that consists of the existing clipping region minus the specified rectangle. 

int ExcludeClipRect(
  HDC hdc,         // handle to device context
  int nLeftRect,   // x-coordinate of upper-left corner of rectangle
  int nTopRect,    // y-coordinate of upper-left corner of rectangle
  int nRightRect,
                   // x-coordinate of lower-right corner of rectangle
  int nBottomRect 
                   // y-coordinate of lower-right corner of rectangle
);

Parameters

hdc
Handle to the device context.
nLeftRect
Specifies the logical x-coordinate of the upper-left corner of the rectangle.
nTopRect
Specifies the logical y-coordinate of the upper-left corner of the rectangle.
nRightRect
Specifies the logical x-coordinate of the lower-right corner of the rectangle.
nBottomRect
Specifies the logical y-coordinate of the lower-right corner of the rectangle.

Return Values

The return value specifies the new clipping region's complexity; it 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 No region was created.

Remarks

The lower and right edges of the specified rectangle are not excluded from the clipping region.

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, IntersectClipRect