The GetClipRgn function retrieves a handle identifying the current application-defined clipping region for the specified device context.
int GetClipRgn(
HDC hdc, | // handle of device context |
HRGN hrgn | // handle of region |
); |
Parameters
hdc
Identifies the device context.
hrgn
Identifies an existing region before the function is called. After the function returns, this parameter identifies a copy of the current clipping region.
Return Values
If the function succeeds and there is no clipping region for the given device context, the return value is zero. If the function succeeds and there is a clipping region for the given device context, the return value is 1. If an error occurs, the return value is - 1.
Remarks
An application-defined clipping region is a clipping region identified by the SelectClipRgn function. It is not a clipping region created when the application calls the BeginPaint function.
If the function succeeds, the hrgn parameter identifies a copy of the current clipping region. Subsequent changes to this copy will not affect the current clipping region.
See Also