This function fills the specified buffer with data describing a region. This data includes the dimensions of the rectangles that make up the region.
At a Glance
| Header file: | Wingdi.h |
| Windows CE versions: | 1.0 and later |
Syntax
DWORD GetRegionData(HRGN hRgn, DWORD dwCount,
LPRGNDATA lpRgnData);
Parameters
hRgn
[in] Handle to the region.
dwCount
[in] Specifies the size, in bytes, of the lpRgnData buffer.
lpRgnData
[out] Long pointer to a RGNDATA structure that receives the information. If this parameter is NULL, the return value contains the number of bytes needed for the region data.
Return Values
If dwCount specifies an adequate number of bytes, 1 indicates success. If dwCount is too small or lpRgnData is NULL, the required number of bytes indicates success. Zero indicates failure.
To get extended error information, call GetLastError.
Remarks
The GetRegionData function is used in conjunction with the ExtCreateRegion function.
Windows CE represents regions differently than other Windows-based desktop platforms. A Windows CE implementation of GetRegionData may return a greater number of rectangles for a specified region than Windows-based desktop platforms.
See Also