CreateEllipticRgn function (wingdi.h)

Article
02/22/2024

The CreateEllipticRgn function creates an elliptical region.

Syntax

HRGN CreateEllipticRgn(
  [in] int x1,
  [in] int y1,
  [in] int x2,
  [in] int y2
);

Parameters

[in] x1

Specifies the x-coordinate in logical units, of the upper-left corner of the bounding rectangle of the ellipse.

[in] y1

Specifies the y-coordinate in logical units, of the upper-left corner of the bounding rectangle of the ellipse.

[in] x2

Specifies the x-coordinate in logical units, of the lower-right corner of the bounding rectangle of the ellipse.

[in] y2

Specifies the y-coordinate in logical units, of the lower-right corner of the bounding rectangle of the ellipse.

Return value

If the function succeeds, the return value is the handle to the region.

If the function fails, the return value is NULL.

Remarks

When you no longer need the HRGN object, call the DeleteObject function to delete it.

A bounding rectangle defines the size, shape, and orientation of the region: The long sides of the rectangle define the length of the ellipse's major axis; the short sides define the length of the ellipse's minor axis; and the center of the rectangle defines the intersection of the major and minor axes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	wingdi.h (include Windows.h)
Library	Gdi32.lib
DLL	Gdi32.dll