CDC::ExcludeClipRect

Creates a new clipping region that consists of the existing clipping region minus the specified rectangle.

int ExcludeClipRect(
   int x1,
   int y1,
   int x2,
   int y2 
);
int ExcludeClipRect(
   LPCRECT lpRect 
);

Parameters

  • x1
    Specifies the logical x-coordinate of the upper-left corner of the rectangle.

  • y1
    Specifies the logical y-coordinate of the upper-left corner of the rectangle.

  • x2
    Specifies the logical x-coordinate of the lower-right corner of the rectangle.

  • y2
    Specifies the logical y-coordinate of the lower-right corner of the rectangle.

  • lpRect
    Specifies the rectangle. Can also be a CRect object.

Return Value

Specifies the new clipping region's type. It can be any of the following values:

  • COMPLEXREGION   The region has overlapping borders.

  • ERROR   No region was created.

  • NULLREGION   The region is empty.

  • SIMPLEREGION   The region has no overlapping borders.

Remarks

The width of the rectangle, specified by the absolute value of x2 – x1, must not exceed 32,767 units. This limit applies to the height of the rectangle as well.

Requirements

Header: afxwin.h

See Also

Reference

CDC Class

Hierarchy Chart

CDC::ExcludeUpdateRgn

ExcludeClipRect

Other Resources

CDC Members