ExcludeClipRect function

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

Syntax


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

Parameters

hdc [in]

A handle to the device context.

nLeftRect [in]

The x-coordinate, in logical units, of the upper-left corner of the rectangle.

nTopRect [in]

The y-coordinate, in logical units, of the upper-left corner of the rectangle.

nRightRect [in]

The x-coordinate, in logical units, of the lower-right corner of the rectangle.

nBottomRect [in]

The y-coordinate, in logical units, of the lower-right corner of the rectangle.

Return value

The return value specifies the new clipping region's complexity; it can be one of the following values.

Return codeDescription
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.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Wingdi.h (include Windows.h)

Library

Gdi32.lib

DLL

Gdi32.dll

See also

Clipping Overview
Clipping Functions
IntersectClipRect

 

 

Build date: 6/12/2013

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.