 Important: |
|---|
| This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
This function fills the specified buffer with data describing a region. This data includes the dimensions of the rectangles that make up the region.
DWORD GetRegionData( HRGN hRgn , DWORD dwCount , LPRGNDATA lpRgnData );
Parameters
- hRgn
- [in] Handle to the region.
- dwCount
- [in] Specifies the size, in bytes, of the lpRgnDatabuffer.
- lpRgnData
- [out] Long pointer to a
RGNDATAstructure 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 dwCountspecifies an adequate number of bytes, 1 indicates success. If dwCountis too small or lpRgnDatais NULL, the required number of bytes indicates success. Zero indicates failure.
To get extended error information, call GetLastError.
Remarks
The GetRegionDatafunction is used in conjunction with the ExtCreateRegionfunction.
Windows CE represents regions differently than other Windows-based desktop platforms. A Windows CE implementation of GetRegionDatamay return a greater number of rectangles for a specified region than Windows-based desktop platforms.
Requirements
Runs on Versions Defined in Include Link to Windows CE OS 1.0 and later Wingdi.h Coredll.lib, Winmgr.lib Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.
See Also