PolylineTo

関数

現在位置から折れ線を描画し現在位置を更新する。

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

シグネチャ

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

BOOL PolylineTo(
    HDC hdc,
    const POINT* apt,
    DWORD cpt
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。
apt	POINT*	in	線の頂点を論理単位で格納した POINT 構造体の配列へのポインター。
cpt	DWORD	in	配列内のポイントの数。

戻り値の型: BOOL

公式ドキュメント

PolylineTo 関数は、1 本以上の直線を描画します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。

解説(Remarks)

Polyline 関数とは異なり、PolylineTo 関数は現在位置を使用し、更新します。

現在のペンを使用して、現在位置から lppt パラメーターで指定された最初のポイントまで線が描画されます。以降の各線については、前の線の終点から lppt で指定された次のポイントまで描画されます。

PolylineTo は、現在位置を最後の線の終点に移動します。

この関数で描画される線分が閉じた図形を形成する場合、その図形は塗りつぶされません。

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

各言語での呼び出し定義

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

BOOL PolylineTo(
    HDC hdc,
    const POINT* apt,
    DWORD cpt
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool PolylineTo(
    IntPtr hdc,   // HDC
    IntPtr apt,   // POINT*
    uint cpt   // DWORD
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function PolylineTo(
    hdc As IntPtr,   ' HDC
    apt As IntPtr,   ' POINT*
    cpt As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' apt : POINT*
' cpt : DWORD
Declare PtrSafe Function PolylineTo Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal apt 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

PolylineTo = ctypes.windll.gdi32.PolylineTo
PolylineTo.restype = wintypes.BOOL
PolylineTo.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_void_p,  # apt : POINT*
    wintypes.DWORD,  # cpt : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
PolylineTo = Fiddle::Function.new(
  lib['PolylineTo'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # apt : POINT*
    -Fiddle::TYPE_INT,  # cpt : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn PolylineTo(
        hdc: *mut core::ffi::c_void,  // HDC
        apt: *const POINT,  // POINT*
        cpt: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool PolylineTo(IntPtr hdc, IntPtr apt, uint cpt);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_PolylineTo' -Namespace Win32 -PassThru
# $api::PolylineTo(hdc, apt, cpt)

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

出力引数:

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