Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

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

Syntax 

int ExcludeClipRect(
  HDC 
hdc, 
  int 
nLeftRect, 
  int 
nTopRect, 
  int 
nRightRect, 
  int 
nBottomRect
);

Parameters

hdc

[in] Handle to the device context.

nLeftRect

[in] Specifies the logical x-coordinate of the upper left corner of the rectangle.

nTopRect

[in] Specifies the logical y-coordinate of the upper left corner of the rectangle.

nRightRect

[in] Specifies the logical x-coordinate of the lower right corner of the rectangle.

nBottomRect

[in] Specifies the logical y-coordinate of the lower right corner of the rectangle.

Return Value

The return value specifies the new clipping region's complexity.

NULLREGION indicates that the region is empty.

SIMPLEREGION indicates that the region is a single rectangle.

COMPLEXREGION indicates that the region is more than one rectangle.

ERROR indicates that no region was created.

Remarks

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

Requirements

Header windows.h
Library coredll.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also