Gdi::GetClipRgn_I

  • Article

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

static WINGDIAPI int WINAPI GetClipRgn_I(
  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 the specified device context has no clipping region, zero indicates success. If the specified device context has a clipping region, 1 indicates success. –1 indicates that an error occurred.

To get extended error information, call GetLastError.

Remarks

This method is an internal version of the GetClipRgn function.

An application-defined clipping region is a clipping region identified by the Gdi::SelectClipRgn_I method. An application-defined clipping region is not a clipping region created when the application calls the GweBypassCoredllThunk_t::BeginPaint_I method.

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 .NET 4.0 and later.
Header: Gdi.hpp.

See Also

GetClipRgn | Gdi::SelectClipRgn_I | GweBypassCoredllThunk_t::BeginPaint_I

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.