Windows GDI
SelectClipRgn
The SelectClipRgn function selects a region as the current clipping region for the specified device context.
|
int SelectClipRgn(
HDC hdc, // handle to DC
HRGN hrgn // handle to region
); |
Parameters
- hdc
- [in] Handle to the device context.
- hrgn
- [in] Handle to the region to be selected.
Return Values
The return value specifies the region's complexity and can be 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.
Example Code
For an example, see Clipping Output.
Windows NT/2000/XP/Vista: Included in Windows NT 3.1 and later.
Windows 95/98/Me: Included in Windows 95 and later.
Header: Declared in Wingdi.h; include Windows.h.
Library: Use Gdi32.lib.
See Also
Clipping Overview, Clipping Functions, ExtSelectClipRgn