GetRegionData

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.

DWORD GetRegionData(
  HRGN hRgn,            // handle to region
  DWORD dwCount,        // size of buffer containing region data
  LPRGNDATA lpRgnData   // pointer to region data
);
 

Parameters

hRgn

Handle to the region.

dwCount

Specifies the size, in bytes, of the lpRgnData buffer.

lpRgnData

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 the function succeeds and dwCount specifies an adequate number of bytes, the return value is 1. If dwCount is too small or lpRgnData is NULL, the return value is the required number of bytes.

If the function fails, the return value is zero.

Windows NT: To get extended error information, call GetLastError.

Remarks

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

Windows CE: Windows CE represents regions differently than other Windows desktop platforms. A Windows CE implementation of GetRegionData may return a greater number of rectangles for a given region than Windows desktop platforms.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Requires version 1.0 or later.
  Header: Declared in wingdi.h.
  Import Library: Use gdi32.lib.

See Also

Regions Overview, Region Functions, ExtCreateRegion, RGNDATA