GetRegionData function (wingdi.h)

Article
10/13/2021
2 minutes to read

The GetRegionData function fills the specified buffer with data describing a region. This data includes the dimensions of the rectangles that make up the region.

Syntax

DWORD GetRegionData(
  [in]  HRGN      hrgn,
  [in]  DWORD     nCount,
  [out] LPRGNDATA lpRgnData
);

Parameters

[in] hrgn

A handle to the region.

[in] nCount

The size, in bytes, of the lpRgnData buffer.

[out] lpRgnData

A pointer to a RGNDATA structure that receives the information. The dimensions of the region are in logical units. If this parameter is NULL, the return value contains the number of bytes needed for the region data.

Return value

If the function succeeds and dwCount specifies an adequate number of bytes, the return value is always dwCount. If dwCount is too small or the function fails, the return value is 0. If lpRgnData is NULL, the return value is the required number of bytes.

If the function fails, the return value is zero.

Remarks

The GetRegionData function is used in conjunction with the ExtCreateRegion function.

Requirements


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