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

ms.custom

f1_keywords

dev_langs

topic_type

api_type

api_location

api_name

NF:wingdi.GetPath

GetPath function (wingdi.h)

The GetPath function retrieves the coordinates defining the endpoints of lines and the control points of curves found in the path that is selected into the specified device context.

GetPath

GetPath function [Windows GDI]

PT_BEZIERTO

PT_CLOSEFIGURE

PT_LINETO

PT_MOVETO

_win32_GetPath

gdi.getpath

wingdi/GetPath

gdi\getpath.htm

gdi

2dc7736a-03fc-4623-a566-6c3e368da174

12/05/2018

GetPath, GetPath function [Windows GDI], PT_BEZIERTO, PT_CLOSEFIGURE, PT_LINETO, PT_MOVETO, _win32_GetPath, gdi.getpath, wingdi/GetPath

wingdi.h

Windows.h

Windows

Windows 2000 Professional [desktop apps only]

Windows 2000 Server [desktop apps only]

Gdi32.lib

Gdi32.dll

Windows

19H1

GetPath

wingdi/GetPath

c++

APIRef

kbSyntax

DllExport

gdi32.dll

Ext-MS-Win-GDI-Internal-Desktop-L1-1-0.dll

GDI32Full.dll

GetPath

GetPath function

-description

The GetPath function retrieves the coordinates defining the endpoints of lines and the control points of curves found in the path that is selected into the specified device context.

-parameters

-param hdc [in]

A handle to a device context that contains a closed path.

-param apt [out]

A pointer to an array of POINT structures that receives the line endpoints and curve control points, in logical coordinates.

-param aj [out]

A pointer to an array of bytes that receives the vertex types. This parameter can be one of the following values.

Type	Description
PT_MOVETO	Specifies that the corresponding point in the lpPoints parameter starts a disjoint figure.
PT_LINETO	Specifies that the previous point and the corresponding point in lpPoints are the endpoints of a line.
PT_BEZIERTO	Specifies that the corresponding point in lpPoints is a control point or ending point for a Bézier curve. PT_BEZIERTO values always occur in sets of three. The point in the path immediately preceding them defines the starting point for the Bézier curve. The first two PT_BEZIERTO points are the control points, and the third PT_BEZIERTO point is the ending (if hard-coded) point.

A PT_LINETO or PT_BEZIERTO value may be combined with the following value (by using the bitwise operator OR) to indicate that the corresponding point is the last point in a figure and the figure should be closed.

Flag	Description
PT_CLOSEFIGURE	Specifies that the figure is automatically closed after the corresponding line or curve is drawn. The figure is closed by drawing a line from the line or curve endpoint to the point corresponding to the last PT_MOVETO.

-param cpt [in]

The total number of POINT structures that can be stored in the array pointed to by lpPoints. This value must be the same as the number of bytes that can be placed in the array pointed to by lpTypes.

-returns

If the nSize parameter is nonzero, the return value is the number of points enumerated. If nSize is 0, the return value is the total number of points in the path (and GetPath writes nothing to the buffers). If nSize is nonzero and is less than the number of points in the path, the return value is 1.

-remarks

The device context identified by the hdc parameter must contain a closed path.

The points of the path are returned in logical coordinates. Points are stored in the path in device coordinates, so GetPath changes the points from device coordinates to logical coordinates by using the inverse of the current transformation.