Pen::GetMiterLimit method (gdipluspen.h)

Article
02/22/2024

The Pen::GetMiterLimit method gets the miter length currently set for this Pen object.

Syntax

REAL GetMiterLimit();

Return value

Type: REAL

This method returns a real number that indicates the miter limit of this Pen object.

Remarks

The miter length is the distance from the intersection of the line walls on the inside of the join to the intersection of the line walls outside of the join. The miter length can be large when the angle between two lines is small. The miter limit is the maximum allowed ratio of miter length to line width. The default value is 10.

Examples

The following example creates a Pen object and gets the miter limit.

Pen pen(Color(255,255,0,0), 4.0f);
REAL miterLimit = pen.GetMiterLimit();

Requirements

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