SetMiterLimit

関数

幾何ペンのマイター接合部の長さ制限を設定する。

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

シグネチャ

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

BOOL SetMiterLimit(
    HDC hdc,
    FLOAT limit,
    FLOAT* old   // optional
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。
limit	FLOAT	in	デバイスコンテキストに設定する新しいマイター制限値を指定します。
old	FLOAT*	outoptional	以前のマイター制限値を受け取る浮動小数点値へのポインター。このパラメーターが NULL の場合、以前のマイター制限値は返されません。

戻り値の型: BOOL

公式ドキュメント

SetMiterLimit 関数は、指定したデバイスコンテキストに対するマイター接合 (miter join) の長さの上限を設定します。

戻り値

関数が成功すると、戻り値は 0 以外の値になります。

関数が失敗すると、戻り値は 0 になります。

解説(Remarks)

マイター長 (miter length) とは、接合部の内側にある線の側壁の交点から、接合部の外側にある線の側壁の交点までの距離として定義されます。マイター制限値とは、マイター長と線幅の比率に許される最大値です。

既定のマイター制限値は 10.0 です。

注意 eNewLimit に 1.0f 未満の float 値を設定すると、関数は失敗します。

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

各言語での呼び出し定義

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

BOOL SetMiterLimit(
    HDC hdc,
    FLOAT limit,
    FLOAT* old   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool SetMiterLimit(
    IntPtr hdc,   // HDC
    float limit,   // FLOAT
    IntPtr old   // FLOAT* optional, out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function SetMiterLimit(
    hdc As IntPtr,   ' HDC
    limit As Single,   ' FLOAT
    old As IntPtr   ' FLOAT* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' limit : FLOAT
' old : FLOAT* optional, out
Declare PtrSafe Function SetMiterLimit Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal limit As Single, _
    ByVal old As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetMiterLimit = ctypes.windll.gdi32.SetMiterLimit
SetMiterLimit.restype = wintypes.BOOL
SetMiterLimit.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_float,  # limit : FLOAT
    ctypes.POINTER(ctypes.c_float),  # old : FLOAT* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
SetMiterLimit = Fiddle::Function.new(
  lib['SetMiterLimit'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_FLOAT,  # limit : FLOAT
    Fiddle::TYPE_VOIDP,  # old : FLOAT* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn SetMiterLimit(
        hdc: *mut core::ffi::c_void,  // HDC
        limit: f32,  // FLOAT
        old: *mut f32  // FLOAT* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool SetMiterLimit(IntPtr hdc, float limit, IntPtr old);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_SetMiterLimit' -Namespace Win32 -PassThru
# $api::SetMiterLimit(hdc, limit, old)

#uselib "GDI32.dll"
#func global SetMiterLimit "SetMiterLimit" sptr, float, sptr
; SetMiterLimit hdc, limit, varptr(old)   ; 戻り値は stat
; hdc : HDC -> "sptr"
; limit : FLOAT -> "float"
; old : FLOAT* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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