Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

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

Syntax

int SelectClipRgn(
  HDC 
hdc, 
  HRGN 
hrgn
); 

Parameters

hdc

[in] Handle to the device context.

hrgn

[in] Handle to the region to be selected.

Return Value

The return value specifies the region'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 a single rectangle.

ERROR indicates that an error occurred; the current clipping region is unaffected.

To get extended error Information, call GetLastError.

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 SelectClipRgnfunction 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.

Requirements

Header windows.h
Library coredll.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also