nf-gdipluspen-pen-setmiterlimit.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	req.product	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:gdipluspen.Pen.SetMiterLimit	Pen::SetMiterLimit (gdipluspen.h)	The Pen::SetMiterLimit method sets the miter limit of this Pen object.	Pen class [GDI+] SetMiterLimit method Pen.SetMiterLimit Pen::SetMiterLimit SetMiterLimit SetMiterLimit method [GDI+] SetMiterLimit method [GDI+] Pen class _gdiplus_CLASS_Pen_SetMiterLimit_miterLimit_ gdiplus._gdiplus_CLASS_Pen_SetMiterLimit_miterLimit_	gdiplus\_gdiplus_CLASS_Pen_SetMiterLimit_miterLimit_.htm	gdiplus	VS|gdicpp|~\gdiplus\gdiplusreference\classes\penclass\penmethods\setmiterlimit.htm	12/05/2018	Pen class [GDI+],SetMiterLimit method, Pen.SetMiterLimit, Pen::SetMiterLimit, SetMiterLimit, SetMiterLimit method [GDI+], SetMiterLimit method [GDI+],Pen class, _gdiplus_CLASS_Pen_SetMiterLimit_miterLimit_, gdiplus._gdiplus_CLASS_Pen_SetMiterLimit_miterLimit_	gdipluspen.h	Gdiplus.h	Windows	Windows XP, Windows 2000 Professional [desktop apps only]	Windows 2000 Server [desktop apps only]										Gdiplus.lib	Gdiplus.dll		Windows			GDI+ 1.0	19H1	Pen::SetMiterLimit gdipluspen/Pen::SetMiterLimit	c++	APIRef kbSyntax	COM	Gdiplus.dll	Pen.SetMiterLimit

Pen::SetMiterLimit

-description

The Pen::SetMiterLimit method sets the miter limit of this Pen object.

-parameters

-param miterLimit [in]

Type: REAL

Real number that specifies the miter limit of this Pen object. A real number value that is less than 1.0f will be replaced with 1.0f.

-returns

Type: Status

If the method succeeds, it returns Ok, which is an element of the Status enumeration.

If the method fails, it returns one of the other elements of the Status enumeration.

-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 stroke width. The default value is 10.0f.

If the miter length of the join of the intersection exceeds the limit of the join, then the join will be beveled to keep it within the limit of the join of the intersection.

Examples

The following example creates a Pen object and sets the miter limit for the pen.

Pen pen(Color(255,255,0,0), 4.0f);
Status stat = pen.SetMiterLimit(10.0f);

-see-also

Joining Lines

Pen

Pen::GetMiterLimit

Pens, Lines, and Rectangles