Fills the specified buffer with data describing the region.

int GetRegionData(
   LPRGNDATA lpRgnData,
   int nCount 
) const;

Parameters

lpRgnData

Points to a RGNDATA data structure that receives the information. If this parameter is NULL, the return value contains the number of bytes needed for the region data.

nCount

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

Return Value

If the function succeeds and nCount specifies an adequate number of bytes, the return value is always nCount. If the function fails, or if nCount specifies less than adequate number of bytes, the return value is 0 (error).

Remarks

This data includes the dimensions of the rectangles that make up the region. This function is used in conjunction with the CRgn::CreateFromData function.

See Also

CRgn Overview | Class Members | Hierarchy Chart | CRgn::CreateFromData