Share via

GetClipRgn

  • Article

This function retrieves a handle identifying the current application-defined clipping region for the specified device context.

int GetClipRgn(
  HDC hdc, 
  HRGN hrgn
);

Parameters

  • hdc
    [in] Handle to the device context.
  • hrgn
    [in, out] Handle to an existing region before the function is called. After the function returns, this parameter is a handle to a copy of the current clipping region.

Return Values

If there is no clipping region for the specified device context, zero indicates success. If there is a clipping region for the specified device context, 1 indicates success. –1 indicates that an error occurred.

To get extended error information, call GetLastError.

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 is a handle to a copy of the current clipping region. Subsequent changes to this copy will not affect the current clipping region.

Requirements

OS Versions: Windows CE 1.0 and later.
Header: Windows.h.
Link Library: Coredll.lib.

See Also

BeginPaint | SelectClipRgn | GDI Functions

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.