GetRegionData

  • Article

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 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.

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

GetLastError, RGNDATA

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.