Gdi::GetRegionData_I

  • Article

This method fills the specified buffer with data describing a region. This data includes the dimensions of the rectangles that make up the region.

static WINGDIAPI DWORD WINAPI GetRegionData_I(
  HRGN hRgn, 
  DWORD dwCount,
  RGNDATA* lpRgnData
);

Parameters

  • hRgn
    [in] Handle to the region.
  • dwCount
    [in] DWORD that 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

This method is an internal version of the GetRegionData function.

Windows CE represents regions differently than other Windows-based desktop platforms. Gdi::GetRegionData_I can return more rectangles for a specified region than Windows-based desktop platforms return for the GetRegionData function.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Gdi.hpp.

See Also

GetRegionData | RGNDATA

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.