GetRegionData function
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 dwCount, _Out_ LPRGNDATA lpRgnData );
Parameters
- hRgn [in]
-
A handle to the region.
- dwCount [in]
-
The size, in bytes, of the lpRgnData buffer.
- lpRgnData [out]
-
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] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also
- Regions Overview
- Region Functions
- CreatePolygonRgn
- CreatePolyPolygonRgn
- CreateRectRgn
- CreateRectRgnIndirect
- CreateRoundRectRgn
- ExtCreateRegion
- RGNDATA