nf-gdipluspen-pen-getdashoffset.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.GetDashOffset	Pen::GetDashOffset (gdipluspen.h)	The Pen::GetDashOffset method gets the distance from the start of the line to the start of the first space in a dashed line.	GetDashOffset GetDashOffset method [GDI+] GetDashOffset method [GDI+] Pen class Pen class [GDI+] GetDashOffset method Pen.GetDashOffset Pen::GetDashOffset _gdiplus_CLASS_Pen_GetDashOffset_ gdiplus._gdiplus_CLASS_Pen_GetDashOffset_	gdiplus\_gdiplus_CLASS_Pen_GetDashOffset_.htm	gdiplus	VS|gdicpp|~\gdiplus\gdiplusreference\classes\penclass\penmethods\getdashoffset.htm	12/05/2018	GetDashOffset, GetDashOffset method [GDI+], GetDashOffset method [GDI+],Pen class, Pen class [GDI+],GetDashOffset method, Pen.GetDashOffset, Pen::GetDashOffset, _gdiplus_CLASS_Pen_GetDashOffset_, gdiplus._gdiplus_CLASS_Pen_GetDashOffset_	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::GetDashOffset gdipluspen/Pen::GetDashOffset	c++	APIRef kbSyntax	COM	Gdiplus.dll	Pen.GetDashOffset

Pen::GetDashOffset

-description

The Pen::GetDashOffset method gets the distance from the start of the line to the start of the first space in a dashed line.

-returns

Type: REAL

This method returns a real number that indicates the distance from the start of the line to the start of the dashes.

-remarks

A positive return value shifts the first dash forward along the path, and a negative return value shifts the start of the path forward along the first dash.

Examples

The following example assumes that dashPen has been defined with a certain dash style and gets the dash offset value.

REAL dashOffset = dashPen.GetDashOffset();

-see-also

Drawing a Custom Dashed Line

Pen

Pen::SetDashOffset

Pens, Lines, and Rectangles