Share via

CDC::GetClipBox

  • Article

Retrieves the dimensions of the tightest bounding rectangle around the current clipping boundary.

virtual int GetClipBox( 
   LPRECT lpRect  
) const;

Parameters

  • lpRect
    Points to the RECT structure or CRect object that is to receive the rectangle dimensions.

Return Value

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

  • COMPLEXREGION   Clipping region has overlapping borders.

  • ERROR   Device context is not valid.

  • NULLREGION   Clipping region is empty.

  • SIMPLEREGION   Clipping region has no overlapping borders.

Remarks

The dimensions are copied to the buffer pointed to by lpRect.

Requirements

Header: afxwin.h

See Also

Reference

CDC Class

Hierarchy Chart

CDC::SelectClipRgn

GetClipBox

RECT Structure