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

ExtCreatePen

関数
スタイルや幅を細かく指定した論理ペンを作成する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HPEN ExtCreatePen(
    DWORD iPenStyle,
    DWORD cWidth,
    const LOGBRUSH* plbrush,
    DWORD cStyle,
    const DWORD* pstyle   // optional
);

パラメーター

名前方向説明
iPenStyleDWORDin

種類、スタイル、端点キャップ、結合の各属性の組み合わせです。各カテゴリの値はビット単位の OR 演算子 ( | ) で結合します。

ペンの種類には、次のいずれかの値を指定できます。

意味
PS_GEOMETRIC
ジオメトリックペンです。
PS_COSMETIC
コスメティックペンです。

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

意味
PS_ALTERNATE
ペンは 1 ピクセルおきに点を打ちます。(このスタイルはコスメティックペンにのみ適用されます。)
PS_SOLID
ペンは実線です。
PS_DASH
ペンは破線です。
PS_DOT
ペンは点線です。
PS_DASHDOT
ペンは破線と点が交互に並びます。
PS_DASHDOTDOT
ペンは破線と 2 つの点が交互に並びます。
PS_NULL
ペンは不可視です。
PS_USERSTYLE
ペンはユーザーが指定したスタイル配列を使用します。
PS_INSIDEFRAME
ペンは実線です。このペンが境界矩形を取る GDI 描画関数で使用される場合、ペンの幅を考慮したうえで図形が境界矩形内に完全に収まるよう、図形の寸法が縮小されます。これはジオメトリックペンにのみ適用されます。

端点キャップはジオメトリックペンに対してのみ指定されます。端点キャップには、次のいずれかの値を指定できます。

意味
PS_ENDCAP_ROUND
端点キャップは丸形です。
PS_ENDCAP_SQUARE
端点キャップは四角形です。
PS_ENDCAP_FLAT
端点キャップは平坦です。

結合はジオメトリックペンに対してのみ指定されます。結合には、次のいずれかの値を指定できます。

意味
PS_JOIN_BEVEL
結合部は面取りされます。
PS_JOIN_MITER
結合部は、SetMiterLimit 関数で設定された現在の制限内にある場合、マイター結合されます。この制限を超える場合は面取りされます。
PS_JOIN_ROUND
結合部は丸められます。
cWidthDWORDinペンの幅です。dwPenStyle パラメーターが PS_GEOMETRIC の場合、幅は論理単位で指定します。dwPenStylePS_COSMETIC の場合、幅は 1 に設定する必要があります。
plbrushLOGBRUSH*inLOGBRUSH 構造体へのポインターです。dwPenStylePS_COSMETIC の場合、lbColor メンバーはペンの色を指定し、lpStyle メンバーは BS_SOLID に設定する必要があります。dwPenStylePS_GEOMETRIC の場合、ペンのブラシ属性を指定するためにすべてのメンバーを使用する必要があります。
cStyleDWORDin

lpStyle 配列の長さを DWORD 単位で指定します。dwPenStylePS_USERSTYLE でない場合、この値は 0 にする必要があります。

スタイル数は 16 に制限されています。

pstyleDWORD*inoptional

配列へのポインターです。最初の値はユーザー定義スタイルにおける最初のダッシュの長さを指定し、2 番目の値は最初のスペースの長さを指定します。以降も同様です。dwPenStylePS_USERSTYLE でない場合、このポインターは NULL にする必要があります。

線の描画中に lpStyle 配列を使い切ると、ポインターは配列の先頭にリセットされます。このとき dwStyleCount が偶数であれば、ダッシュとスペースのパターンが繰り返されます。ただし dwStyleCount が奇数の場合、ポインターがリセットされるとパターンが反転します。つまり lpStyle の最初の要素はスペースを、2 番目の要素はダッシュを表すようになります。以降も同様です。

戻り値の型: HPEN

公式ドキュメント

ExtCreatePen 関数は、指定したスタイル、幅、およびブラシ属性を持つ論理コスメティックペンまたはジオメトリックペンを作成します。

戻り値

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

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

解説(Remarks)

ジオメトリックペンは任意の幅を持つことができ、ディザリングやパターンなど、ブラシのあらゆる属性を持つことができます。コスメティックペンは 1 ピクセル幅の単色のみですが、一般にジオメトリックペンよりも高速です。

ジオメトリックペンの幅は常にワールド単位で指定します。コスメティックペンの幅は常に 1 です。

端点キャップと結合はジオメトリックペンに対してのみ指定されます。

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

dwPenStylePS_COSMETIC かつ PS_USERSTYLE の場合、lpStyle 配列の各要素はダッシュとスペースの長さをスタイル単位で指定します。スタイル単位は、ペンを使用して線を描画するデバイスによって定義されます。

dwPenStylePS_GEOMETRIC かつ PS_USERSTYLE の場合、lpStyle 配列の各要素はダッシュとスペースの長さを論理単位で指定します。

dwPenStylePS_ALTERNATE の場合、スタイル単位は無視され、1 ピクセルおきに点が打たれます。

lplb が指す LOGBRUSH 構造体の lbStyle メンバーが BS_PATTERN の場合、その構造体の lbHatch メンバーが指すビットマップを DIB セクションにすることはできません。DIB セクションとは CreateDIBSection で作成されたビットマップです。そのビットマップが DIB セクションである場合、ExtCreatePen 関数は失敗します。

アプリケーションは、指定したペンが不要になったら DeleteObject 関数を呼び出してペンを削除する必要があります。

ICM: ペンの作成時にはカラーマネジメントは行われません。ただし、ICM 対応のデバイスコンテキストにペンが選択されると、カラーマネジメントが実行されます。

例については、Using Pens を参照してください。

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

各言語での呼び出し定義

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

HPEN ExtCreatePen(
    DWORD iPenStyle,
    DWORD cWidth,
    const LOGBRUSH* plbrush,
    DWORD cStyle,
    const DWORD* pstyle   // optional
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern IntPtr ExtCreatePen(
    uint iPenStyle,   // DWORD
    uint cWidth,   // DWORD
    IntPtr plbrush,   // LOGBRUSH*
    uint cStyle,   // DWORD
    IntPtr pstyle   // DWORD* optional
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function ExtCreatePen(
    iPenStyle As UInteger,   ' DWORD
    cWidth As UInteger,   ' DWORD
    plbrush As IntPtr,   ' LOGBRUSH*
    cStyle As UInteger,   ' DWORD
    pstyle As IntPtr   ' DWORD* optional
) As IntPtr
End Function
' iPenStyle : DWORD
' cWidth : DWORD
' plbrush : LOGBRUSH*
' cStyle : DWORD
' pstyle : DWORD* optional
Declare PtrSafe Function ExtCreatePen Lib "gdi32" ( _
    ByVal iPenStyle As Long, _
    ByVal cWidth As Long, _
    ByVal plbrush As LongPtr, _
    ByVal cStyle As Long, _
    ByVal pstyle As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ExtCreatePen = ctypes.windll.gdi32.ExtCreatePen
ExtCreatePen.restype = ctypes.c_void_p
ExtCreatePen.argtypes = [
    wintypes.DWORD,  # iPenStyle : DWORD
    wintypes.DWORD,  # cWidth : DWORD
    ctypes.c_void_p,  # plbrush : LOGBRUSH*
    wintypes.DWORD,  # cStyle : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pstyle : DWORD* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
ExtCreatePen = Fiddle::Function.new(
  lib['ExtCreatePen'],
  [
    -Fiddle::TYPE_INT,  # iPenStyle : DWORD
    -Fiddle::TYPE_INT,  # cWidth : DWORD
    Fiddle::TYPE_VOIDP,  # plbrush : LOGBRUSH*
    -Fiddle::TYPE_INT,  # cStyle : DWORD
    Fiddle::TYPE_VOIDP,  # pstyle : DWORD* optional
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "gdi32")]
extern "system" {
    fn ExtCreatePen(
        iPenStyle: u32,  // DWORD
        cWidth: u32,  // DWORD
        plbrush: *const LOGBRUSH,  // LOGBRUSH*
        cStyle: u32,  // DWORD
        pstyle: *const u32  // DWORD* optional
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("GDI32.dll")]
public static extern IntPtr ExtCreatePen(uint iPenStyle, uint cWidth, IntPtr plbrush, uint cStyle, IntPtr pstyle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_ExtCreatePen' -Namespace Win32 -PassThru
# $api::ExtCreatePen(iPenStyle, cWidth, plbrush, cStyle, pstyle)
#uselib "GDI32.dll"
#func global ExtCreatePen "ExtCreatePen" sptr, sptr, sptr, sptr, sptr
; ExtCreatePen iPenStyle, cWidth, varptr(plbrush), cStyle, varptr(pstyle)   ; 戻り値は stat
; iPenStyle : DWORD -> "sptr"
; cWidth : DWORD -> "sptr"
; plbrush : LOGBRUSH* -> "sptr"
; cStyle : DWORD -> "sptr"
; pstyle : DWORD* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "GDI32.dll"
#cfunc global ExtCreatePen "ExtCreatePen" int, int, var, int, var
; res = ExtCreatePen(iPenStyle, cWidth, plbrush, cStyle, pstyle)
; iPenStyle : DWORD -> "int"
; cWidth : DWORD -> "int"
; plbrush : LOGBRUSH* -> "var"
; cStyle : DWORD -> "int"
; pstyle : DWORD* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HPEN ExtCreatePen(DWORD iPenStyle, DWORD cWidth, LOGBRUSH* plbrush, DWORD cStyle, DWORD* pstyle)
#uselib "GDI32.dll"
#cfunc global ExtCreatePen "ExtCreatePen" int, int, var, int, var
; res = ExtCreatePen(iPenStyle, cWidth, plbrush, cStyle, pstyle)
; iPenStyle : DWORD -> "int"
; cWidth : DWORD -> "int"
; plbrush : LOGBRUSH* -> "var"
; cStyle : DWORD -> "int"
; pstyle : DWORD* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procExtCreatePen = gdi32.NewProc("ExtCreatePen")
)

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

extern "gdi32" fn ExtCreatePen(
    iPenStyle: u32, // DWORD
    cWidth: u32, // DWORD
    plbrush: [*c]LOGBRUSH, // LOGBRUSH*
    cStyle: u32, // DWORD
    pstyle: [*c]u32 // DWORD* optional
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc ExtCreatePen(
    iPenStyle: uint32,  # DWORD
    cWidth: uint32,  # DWORD
    plbrush: ptr LOGBRUSH,  # LOGBRUSH*
    cStyle: uint32,  # DWORD
    pstyle: ptr uint32  # DWORD* optional
): pointer {.importc: "ExtCreatePen", stdcall, dynlib: "GDI32.dll".}
pragma(lib, "gdi32");
extern(Windows)
void* ExtCreatePen(
    uint iPenStyle,   // DWORD
    uint cWidth,   // DWORD
    LOGBRUSH* plbrush,   // LOGBRUSH*
    uint cStyle,   // DWORD
    uint* pstyle   // DWORD* optional
);
ccall((:ExtCreatePen, "GDI32.dll"), stdcall, Ptr{Cvoid},
      (UInt32, UInt32, Ptr{LOGBRUSH}, UInt32, Ptr{UInt32}),
      iPenStyle, cWidth, plbrush, cStyle, pstyle)
# iPenStyle : DWORD -> UInt32
# cWidth : DWORD -> UInt32
# plbrush : LOGBRUSH* -> Ptr{LOGBRUSH}
# cStyle : DWORD -> UInt32
# pstyle : DWORD* optional -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* ExtCreatePen(
    uint32_t iPenStyle,
    uint32_t cWidth,
    void* plbrush,
    uint32_t cStyle,
    uint32_t* pstyle);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.ExtCreatePen(iPenStyle, cWidth, plbrush, cStyle, pstyle)
-- iPenStyle : DWORD
-- cWidth : DWORD
-- plbrush : LOGBRUSH*
-- cStyle : DWORD
-- pstyle : DWORD* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const ExtCreatePen = lib.func('__stdcall', 'ExtCreatePen', 'void *', ['uint32_t', 'uint32_t', 'void *', 'uint32_t', 'uint32_t *']);
// ExtCreatePen(iPenStyle, cWidth, plbrush, cStyle, pstyle)
// iPenStyle : DWORD -> 'uint32_t'
// cWidth : DWORD -> 'uint32_t'
// plbrush : LOGBRUSH* -> 'void *'
// cStyle : DWORD -> 'uint32_t'
// pstyle : DWORD* optional -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  ExtCreatePen: { parameters: ["u32", "u32", "pointer", "u32", "pointer"], result: "pointer" },
});
// lib.symbols.ExtCreatePen(iPenStyle, cWidth, plbrush, cStyle, pstyle)
// iPenStyle : DWORD -> "u32"
// cWidth : DWORD -> "u32"
// plbrush : LOGBRUSH* -> "pointer"
// cStyle : DWORD -> "u32"
// pstyle : DWORD* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* ExtCreatePen(
    uint32_t iPenStyle,
    uint32_t cWidth,
    void* plbrush,
    uint32_t cStyle,
    uint32_t* pstyle);
C, "GDI32.dll");
// $ffi->ExtCreatePen(iPenStyle, cWidth, plbrush, cStyle, pstyle);
// iPenStyle : DWORD
// cWidth : DWORD
// plbrush : LOGBRUSH*
// cStyle : DWORD
// pstyle : DWORD* optional
// 構造体/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 ExtCreatePen(
        int iPenStyle,   // DWORD
        int cWidth,   // DWORD
        Pointer plbrush,   // LOGBRUSH*
        int cStyle,   // DWORD
        IntByReference pstyle   // DWORD* optional
    );
}
@[Link("gdi32")]
lib LibGDI32
  fun ExtCreatePen = ExtCreatePen(
    iPenStyle : UInt32,   # DWORD
    cWidth : UInt32,   # DWORD
    plbrush : LOGBRUSH*,   # LOGBRUSH*
    cStyle : UInt32,   # DWORD
    pstyle : UInt32*   # DWORD* optional
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ExtCreatePenNative = Pointer<Void> Function(Uint32, Uint32, Pointer<Void>, Uint32, Pointer<Uint32>);
typedef ExtCreatePenDart = Pointer<Void> Function(int, int, Pointer<Void>, int, Pointer<Uint32>);
final ExtCreatePen = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<ExtCreatePenNative, ExtCreatePenDart>('ExtCreatePen');
// iPenStyle : DWORD -> Uint32
// cWidth : DWORD -> Uint32
// plbrush : LOGBRUSH* -> Pointer<Void>
// cStyle : DWORD -> Uint32
// pstyle : DWORD* optional -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ExtCreatePen(
  iPenStyle: DWORD;   // DWORD
  cWidth: DWORD;   // DWORD
  plbrush: Pointer;   // LOGBRUSH*
  cStyle: DWORD;   // DWORD
  pstyle: Pointer   // DWORD* optional
): THandle; stdcall;
  external 'GDI32.dll' name 'ExtCreatePen';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ExtCreatePen"
  c_ExtCreatePen :: Word32 -> Word32 -> Ptr () -> Word32 -> Ptr Word32 -> IO (Ptr ())
-- iPenStyle : DWORD -> Word32
-- cWidth : DWORD -> Word32
-- plbrush : LOGBRUSH* -> Ptr ()
-- cStyle : DWORD -> Word32
-- pstyle : DWORD* optional -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let extcreatepen =
  foreign "ExtCreatePen"
    (uint32_t @-> uint32_t @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning (ptr void))
(* iPenStyle : DWORD -> uint32_t *)
(* cWidth : DWORD -> uint32_t *)
(* plbrush : LOGBRUSH* -> (ptr void) *)
(* cStyle : DWORD -> uint32_t *)
(* pstyle : DWORD* optional -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

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

関連項目

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