Prev Next

GetClipBox info  Overview  Group

The GetClipBox 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 or clip path, as well as any overlapping windows.

int GetClipBox(

    HDC hdc,

// handle of the device context

    LPRECT lprc 

// address of structure with rectangle

   );

Parameters

hdc
Identifies the device context.
lprc
Points to a RECT structure that is to receive the rectangle dimensions.

Return Values

If the function succeeds, the return value specifies the clipping box’s complexity and can be any one of the following values:

Value

Meaning

NULLREGION

Region is empty.

SIMPLEREGION

Region is a single rectangle.

COMPLEXREGION

Region is more than one rectangle.

ERROR

An error occurred.

GetClipBox returns logical coordinates based on the given device context. To get extended error information, call GetLastError.

See Also

RECT 

See: