GetClipBox

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function retrieves the dimensions of the tightest bounding rectangle that can be drawn around the current visible area on the device. The visible area is defined by the current clipping region as well as any overlapping windows.

Syntax

int GetClipBox(
  HDC hdc, 
  LPRECT lprc
); 

Parameters

• hdc
  [in] Handle to the device context.

• lprc
  [out] Long pointer to a RECT structure that is to receive the rectangle dimensions.

Return Value

The return value specifies the clipping box'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 an error occurred.

To get extended error information, call GetLastError.

Remarks

GetClipBox returns logical coordinates based on the specified device context.

Requirements

See Also

Reference

RECT
GDI Functions