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

A Windows CE implementation of GetRegionData may return more rectangles for a specified region than a Windows-based desktop platform implementation.

Requirements

OS Versions: Windows CE 1.0 and later.
Header: Windows.h.
Link Library: Coredll.lib.

See Also

RGNDATA | GDI Functions

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.