SelectClipRgn

The SelectClipRgn function selects a region as the current clipping region for the specified device context.

int SelectClipRgn(

HDC hdc, // handle of device context
HRGN hrgn // handle of region to be selected
);  

Parameters

hdc

Identifies the device context.

hrgn

Identifies the region to be selected.

Return Values

If the function succeeds, the return value specifies the region'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. (The previous clipping region is unaffected.)

Remarks

Only a copy of the selected region is used. The region itself can be selected for any number of other device contexts or it can be deleted.

The SelectClipRgn function assumes that the coordinates for a region are specified in device units.

To remove a device-context's clipping region, specify a NULL region handle.

See Also

ExtSelectClipRgn