GetClipRgn function (wingdi.h)

Article
02/22/2024

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

Syntax

int GetClipRgn(
  [in] HDC  hdc,
  [in] HRGN hrgn
);

Parameters

[in] hdc

A handle to the device context.

[in] hrgn

A 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 value

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

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	wingdi.h (include Windows.h)
Library	Gdi32.lib
DLL	Gdi32.dll