Polyline

関数

点配列を結ぶ折れ線を描画する。

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

シグネチャ

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

BOOL Polyline(
    HDC hdc,
    const POINT* apt,
    INT cpt
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。
apt	POINT*	in	論理単位による POINT 構造体の配列へのポインター。
cpt	INT	in	配列内の点の数。この数は 2 以上である必要があります。

戻り値の型: BOOL

公式ドキュメント

Polyline 関数は、指定された配列内の点を接続して一連の線分を描画します。

戻り値

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

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

解説(Remarks)

線は、現在のペンを使用して最初の点から後続の点へと描画されます。LineTo 関数や PolylineTo 関数とは異なり、Polyline 関数は現在位置を使用も更新もしません。

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

各言語での呼び出し定義

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

BOOL Polyline(
    HDC hdc,
    const POINT* apt,
    INT cpt
);

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

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

' hdc : HDC
' apt : POINT*
' cpt : INT
Declare PtrSafe Function Polyline 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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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