GetPath

関数

DCのパスを構成する点と頂点種別を取得する。

DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// GDI32.dll
#include <windows.h>

INT GetPath(
    HDC hdc,
    POINT* apt,   // optional
    BYTE* aj,   // optional
    INT cpt
);

パラメーター

名前

型

方向

説明

hdc

HDC

閉じたパスを含むデバイスコンテキストへのハンドル。

apt

POINT*

outoptional

線分の端点および曲線の制御点を論理座標で受け取る POINT 構造体の配列へのポインター。

BYTE*

outoptional

頂点の種類を受け取るバイト配列へのポインター。このパラメーターには次のいずれかの値を指定できます。

Type	説明
PT_MOVETO	lpPoints パラメーター内の対応する点が、独立した図形の開始点であることを指定します。
PT_LINETO	直前の点と lpPoints 内の対応する点が、線分の端点であることを指定します。
PT_BEZIERTO	lpPoints 内の対応する点が、ベジエ曲線の制御点または終点であることを指定します。 PT_BEZIERTO 値は常に 3 個ずつ組になって現れます。それらの直前にあるパス上の点がベジエ曲線の開始点を定義します。最初の 2 個の PT_BEZIERTO 点が制御点であり、3 個目の PT_BEZIERTO 点が終点です。

PT_LINETO または PT_BEZIERTO 値は、対応する点が図形内の最後の点であり図形を閉じる必要があることを示すために、次の値とビットごとの OR 演算子で組み合わせることができます。

Flag	説明
PT_CLOSEFIGURE	対応する線分または曲線が描画された後、図形が自動的に閉じられることを指定します。図形は、線分または曲線の端点から、最後の PT_MOVETO に対応する点へ線を引くことによって閉じられます。

cpt

INT

lpPoints が指す配列に格納できる POINT 構造体の総数。この値は、lpTypes が指す配列に格納できるバイト数と同じである必要があります。

戻り値の型: INT

公式ドキュメント

GetPath 関数は、指定したデバイスコンテキストに選択されているパス内の、線分の端点および曲線の制御点を定義する座標を取得します。

戻り値

nSize パラメーターが 0 以外の場合、戻り値は列挙された点の数です。nSize が 0 の場合、戻り値はパス内の点の総数であり、GetPath はバッファーに何も書き込みません。nSize が 0 以外で、かつパス内の点の数より小さい場合、戻り値は 1 です。

解説(Remarks)

hdc パラメーターで識別されるデバイスコンテキストには、閉じたパスが含まれている必要があります。

パスの点は論理座標で返されます。点はパス内にデバイス座標で格納されているため、GetPath は現在の変換の逆変換を使用して、点をデバイス座標から論理座標へ変換します。

パス内のすべての曲線を線分に変換するには、GetPath を呼び出す前に FlattenPath 関数を呼び出すことができます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// GDI32.dll
#include <windows.h>

INT GetPath(
    HDC hdc,
    POINT* apt,   // optional
    BYTE* aj,   // optional
    INT cpt
);

[DllImport("GDI32.dll", ExactSpelling = true)]
static extern int GetPath(
    IntPtr hdc,   // HDC
    IntPtr apt,   // POINT* optional, out
    IntPtr aj,   // BYTE* optional, out
    int cpt   // INT
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GetPath(
    hdc As IntPtr,   ' HDC
    apt As IntPtr,   ' POINT* optional, out
    aj As IntPtr,   ' BYTE* optional, out
    cpt As Integer   ' INT
) As Integer
End Function

' hdc : HDC
' apt : POINT* optional, out
' aj : BYTE* optional, out
' cpt : INT
Declare PtrSafe Function GetPath Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal apt As LongPtr, _
    ByVal aj As LongPtr, _
    ByVal cpt As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetPath = ctypes.windll.gdi32.GetPath
GetPath.restype = ctypes.c_int
GetPath.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_void_p,  # apt : POINT* optional, out
    ctypes.POINTER(ctypes.c_ubyte),  # aj : BYTE* optional, out
    ctypes.c_int,  # cpt : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetPath = Fiddle::Function.new(
  lib['GetPath'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # apt : POINT* optional, out
    Fiddle::TYPE_VOIDP,  # aj : BYTE* optional, out
    Fiddle::TYPE_INT,  # cpt : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetPath(
        hdc: *mut core::ffi::c_void,  // HDC
        apt: *mut POINT,  // POINT* optional, out
        aj: *mut u8,  // BYTE* optional, out
        cpt: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll")]
public static extern int GetPath(IntPtr hdc, IntPtr apt, IntPtr aj, int cpt);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetPath' -Namespace Win32 -PassThru
# $api::GetPath(hdc, apt, aj, cpt)

#uselib "GDI32.dll"
#func global GetPath "GetPath" sptr, sptr, sptr, sptr
; GetPath hdc, varptr(apt), varptr(aj), cpt   ; 戻り値は stat
; hdc : HDC -> "sptr"
; apt : POINT* optional, out -> "sptr"
; aj : BYTE* optional, out -> "sptr"
; cpt : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global GetPath "GetPath" sptr, var, var, int
; res = GetPath(hdc, apt, aj, cpt)
; hdc : HDC -> "sptr"
; apt : POINT* optional, out -> "var"
; aj : BYTE* optional, out -> "var"
; cpt : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global GetPath "GetPath" sptr, sptr, sptr, int
; res = GetPath(hdc, varptr(apt), varptr(aj), cpt)
; hdc : HDC -> "sptr"
; apt : POINT* optional, out -> "sptr"
; aj : BYTE* optional, out -> "sptr"
; cpt : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。