Win32 API 日本語リファレンス
ホームGraphics.Gdi › CreatePen

CreatePen

関数
指定したスタイル・幅・色のペンを作成する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HPEN CreatePen(
    PEN_STYLE iStyle,
    INT cWidth,
    COLORREF color
);

パラメーター

名前方向説明
iStylePEN_STYLEin

ペンのスタイル。次のいずれかの値を指定できます。

意味
PS_SOLID
ペンは実線です。
PS_DASH
ペンは破線です。このスタイルは、ペンの幅がデバイス単位で 1 以下の場合にのみ有効です。
PS_DOT
ペンは点線です。このスタイルは、ペンの幅がデバイス単位で 1 以下の場合にのみ有効です。
PS_DASHDOT
ペンは破線と点が交互に並びます。このスタイルは、ペンの幅がデバイス単位で 1 以下の場合にのみ有効です。
PS_DASHDOTDOT
ペンは破線と二重点が交互に並びます。このスタイルは、ペンの幅がデバイス単位で 1 以下の場合にのみ有効です。
PS_NULL
ペンは表示されません。
PS_INSIDEFRAME
ペンは実線です。境界矩形を受け取る GDI 描画関数でこのペンを使用すると、ペンの幅を考慮して図形が境界矩形に完全に収まるように図形の寸法が縮小されます。これはジオメトリックペンにのみ適用されます。
cWidthINTin

ペンの幅(論理単位)。nWidth が 0 の場合、現在の変換に関係なく、ペンの幅は 1 ピクセルになります。

次のスタイル(PS_DASHPS_DOTPS_DASHDOTPS_DASHDOTDOT)に対して 1 より大きい幅を指定した場合、CreatePen は指定された幅で PS_SOLID スタイルのペンを返します。

colorCOLORREFinペンの色を表すカラー参照。COLORREF 構造体を生成するには、RGB マクロを使用します。

戻り値の型: HPEN

公式ドキュメント

CreatePen 関数は、指定されたスタイル、幅、色を持つ論理ペンを作成します。このペンはその後デバイスコンテキストに選択して、線や曲線の描画に使用できます。

戻り値

関数が成功した場合、戻り値は論理ペンを識別するハンドルです。

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

解説(Remarks)

アプリケーションは論理ペンを作成した後、SelectObject 関数を呼び出して、そのペンをデバイスコンテキストに選択できます。ペンをデバイスコンテキストに選択すると、線や曲線の描画に使用できます。

nWidth パラメーターに指定した値が 0 の場合、作成されたペンで描画される線は、現在の変換に関係なく常に幅 1 ピクセルになります。

nWidth に指定した値が 1 より大きい場合、fnPenStyle パラメーターは PS_NULLPS_SOLID、または PS_INSIDEFRAME のいずれかでなければなりません。

nWidth に指定した値が 1 より大きく、fnPenStylePS_INSIDEFRAME の場合、ペンに関連付けられた線は、多角形および折れ線を除くすべてのプリミティブのフレーム内側に描画されます。

nWidth に指定した値が 1 より大きく、fnPenStylePS_INSIDEFRAME で、crColor パラメーターに指定した色が論理パレットのエントリのいずれにも一致しない場合、システムはディザリングされた色を使用して線を描画します。ディザリングされた色は実線ペンでは使用できません。

iStyle パラメーターに PS_DASHPS_DOTPS_DASHDOT、または PS_DASHDOTDOT を使用する場合、破線や点の間の隙間を透明にするには、SetBkMode を使用してモードを TRANSPARENT に設定します。

ペンが不要になったら、DeleteObject 関数を呼び出して削除します。

ICM: 作成時には色管理は行われません。ただし、ICM が有効なデバイスコンテキストにペンを選択すると、色管理が実行されます。

例については、色付きのペンとブラシの作成を参照してください。

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

各言語での呼び出し定義

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

HPEN CreatePen(
    PEN_STYLE iStyle,
    INT cWidth,
    COLORREF color
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern IntPtr CreatePen(
    int iStyle,   // PEN_STYLE
    int cWidth,   // INT
    uint color   // COLORREF
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function CreatePen(
    iStyle As Integer,   ' PEN_STYLE
    cWidth As Integer,   ' INT
    color As UInteger   ' COLORREF
) As IntPtr
End Function
' iStyle : PEN_STYLE
' cWidth : INT
' color : COLORREF
Declare PtrSafe Function CreatePen Lib "gdi32" ( _
    ByVal iStyle As Long, _
    ByVal cWidth As Long, _
    ByVal color As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreatePen = ctypes.windll.gdi32.CreatePen
CreatePen.restype = ctypes.c_void_p
CreatePen.argtypes = [
    ctypes.c_int,  # iStyle : PEN_STYLE
    ctypes.c_int,  # cWidth : INT
    wintypes.DWORD,  # color : COLORREF
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
CreatePen = Fiddle::Function.new(
  lib['CreatePen'],
  [
    Fiddle::TYPE_INT,  # iStyle : PEN_STYLE
    Fiddle::TYPE_INT,  # cWidth : INT
    -Fiddle::TYPE_INT,  # color : COLORREF
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "gdi32")]
extern "system" {
    fn CreatePen(
        iStyle: i32,  // PEN_STYLE
        cWidth: i32,  // INT
        color: u32  // COLORREF
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("GDI32.dll")]
public static extern IntPtr CreatePen(int iStyle, int cWidth, uint color);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_CreatePen' -Namespace Win32 -PassThru
# $api::CreatePen(iStyle, cWidth, color)
#uselib "GDI32.dll"
#func global CreatePen "CreatePen" sptr, sptr, sptr
; CreatePen iStyle, cWidth, color   ; 戻り値は stat
; iStyle : PEN_STYLE -> "sptr"
; cWidth : INT -> "sptr"
; color : COLORREF -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "GDI32.dll"
#cfunc global CreatePen "CreatePen" int, int, int
; res = CreatePen(iStyle, cWidth, color)
; iStyle : PEN_STYLE -> "int"
; cWidth : INT -> "int"
; color : COLORREF -> "int"
; HPEN CreatePen(PEN_STYLE iStyle, INT cWidth, COLORREF color)
#uselib "GDI32.dll"
#cfunc global CreatePen "CreatePen" int, int, int
; res = CreatePen(iStyle, cWidth, color)
; iStyle : PEN_STYLE -> "int"
; cWidth : INT -> "int"
; color : COLORREF -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procCreatePen = gdi32.NewProc("CreatePen")
)

// iStyle (PEN_STYLE), cWidth (INT), color (COLORREF)
r1, _, err := procCreatePen.Call(
	uintptr(iStyle),
	uintptr(cWidth),
	uintptr(color),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HPEN
function CreatePen(
  iStyle: Integer;   // PEN_STYLE
  cWidth: Integer;   // INT
  color: DWORD   // COLORREF
): THandle; stdcall;
  external 'GDI32.dll' name 'CreatePen';
result := DllCall("GDI32\CreatePen"
    , "Int", iStyle   ; PEN_STYLE
    , "Int", cWidth   ; INT
    , "UInt", color   ; COLORREF
    , "Ptr")   ; return: HPEN
●CreatePen(iStyle, cWidth, color) = DLL("GDI32.dll", "void* CreatePen(int, int, dword)")
# 呼び出し: CreatePen(iStyle, cWidth, color)
# iStyle : PEN_STYLE -> "int"
# cWidth : INT -> "int"
# color : COLORREF -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "gdi32" fn CreatePen(
    iStyle: i32, // PEN_STYLE
    cWidth: i32, // INT
    color: u32 // COLORREF
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc CreatePen(
    iStyle: int32,  # PEN_STYLE
    cWidth: int32,  # INT
    color: uint32  # COLORREF
): pointer {.importc: "CreatePen", stdcall, dynlib: "GDI32.dll".}
pragma(lib, "gdi32");
extern(Windows)
void* CreatePen(
    int iStyle,   // PEN_STYLE
    int cWidth,   // INT
    uint color   // COLORREF
);
ccall((:CreatePen, "GDI32.dll"), stdcall, Ptr{Cvoid},
      (Int32, Int32, UInt32),
      iStyle, cWidth, color)
# iStyle : PEN_STYLE -> Int32
# cWidth : INT -> Int32
# color : COLORREF -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* CreatePen(
    int32_t iStyle,
    int32_t cWidth,
    uint32_t color);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.CreatePen(iStyle, cWidth, color)
-- iStyle : PEN_STYLE
-- cWidth : INT
-- color : COLORREF
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const CreatePen = lib.func('__stdcall', 'CreatePen', 'void *', ['int32_t', 'int32_t', 'uint32_t']);
// CreatePen(iStyle, cWidth, color)
// iStyle : PEN_STYLE -> 'int32_t'
// cWidth : INT -> 'int32_t'
// color : COLORREF -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  CreatePen: { parameters: ["i32", "i32", "u32"], result: "pointer" },
});
// lib.symbols.CreatePen(iStyle, cWidth, color)
// iStyle : PEN_STYLE -> "i32"
// cWidth : INT -> "i32"
// color : COLORREF -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* CreatePen(
    int32_t iStyle,
    int32_t cWidth,
    uint32_t color);
C, "GDI32.dll");
// $ffi->CreatePen(iStyle, cWidth, color);
// iStyle : PEN_STYLE
// cWidth : INT
// color : COLORREF
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Gdi32 extends StdCallLibrary {
    Gdi32 INSTANCE = Native.load("gdi32", Gdi32.class);
    Pointer CreatePen(
        int iStyle,   // PEN_STYLE
        int cWidth,   // INT
        int color   // COLORREF
    );
}
@[Link("gdi32")]
lib LibGDI32
  fun CreatePen = CreatePen(
    iStyle : Int32,   # PEN_STYLE
    cWidth : Int32,   # INT
    color : UInt32   # COLORREF
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CreatePenNative = Pointer<Void> Function(Int32, Int32, Uint32);
typedef CreatePenDart = Pointer<Void> Function(int, int, int);
final CreatePen = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<CreatePenNative, CreatePenDart>('CreatePen');
// iStyle : PEN_STYLE -> Int32
// cWidth : INT -> Int32
// color : COLORREF -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreatePen(
  iStyle: Integer;   // PEN_STYLE
  cWidth: Integer;   // INT
  color: DWORD   // COLORREF
): THandle; stdcall;
  external 'GDI32.dll' name 'CreatePen';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreatePen"
  c_CreatePen :: Int32 -> Int32 -> Word32 -> IO (Ptr ())
-- iStyle : PEN_STYLE -> Int32
-- cWidth : INT -> Int32
-- color : COLORREF -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createpen =
  foreign "CreatePen"
    (int32_t @-> int32_t @-> uint32_t @-> returning (ptr void))
(* iStyle : PEN_STYLE -> int32_t *)
(* cWidth : INT -> int32_t *)
(* color : COLORREF -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("CreatePen" create-pen :convention :stdcall) :pointer
  (i-style :int32)   ; PEN_STYLE
  (c-width :int32)   ; INT
  (color :uint32))   ; COLORREF
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreatePen = Win32::API::More->new('GDI32',
    'HANDLE CreatePen(int iStyle, int cWidth, DWORD color)');
# my $ret = $CreatePen->Call($iStyle, $cWidth, $color);
# iStyle : PEN_STYLE -> int
# cWidth : INT -> int
# color : COLORREF -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型