GetMetaRgn function (wingdi.h)

Article
02/22/2024

The GetMetaRgn function retrieves the current metaregion for the specified device context.

Syntax

int GetMetaRgn(
  [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 metaregion.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

Remarks

If the function succeeds, hrgn is a handle to a copy of the current metaregion. Subsequent changes to this copy will not affect the current metaregion.

The current clipping region of a device context is defined by the intersection of its clipping region and its metaregion.

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