GetCharWidthI

関数

グリフインデックスごとの文字幅を取得する。

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

シグネチャ

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

BOOL GetCharWidthI(
    HDC hdc,
    DWORD giFirst,
    DWORD cgi,
    WORD* pgi,   // optional
    INT* piWidths
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドルです。
giFirst	DWORD	in	連続するグリフインデックスのグループ内で最初のグリフインデックスです。
cgi	DWORD	in	グリフインデックスの数です。
pgi	WORD*	inoptional	グリフインデックスの配列へのポインターです。このパラメーターが NULL でない場合、giFirst パラメーターの代わりに使用されます。
piWidths	INT*	out	幅を論理座標で受け取るバッファーへのポインターです。

戻り値の型: BOOL

公式ドキュメント

GetCharWidthI 関数は、現在のフォントから、指定された範囲の連続するグリフインデックスの幅を論理座標で取得します。

戻り値

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

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

解説(Remarks)

GetCharWidthI 関数は、pgi パラメーターが NULL の場合、連続するグリフインデックスを処理します。このとき、giFirst パラメーターが処理対象の最初のグリフインデックスを示し、cgi パラメーターが処理するグリフインデックスの数を示します。それ以外の場合、GetCharWidthI 関数は pgi パラメーターが指すグリフインデックスの配列を処理し、cgi パラメーターが処理するグリフインデックスの数を示します。

文字が現在のフォントに存在しない場合、その文字には既定の文字の幅が割り当てられます。

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

各言語での呼び出し定義

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

BOOL GetCharWidthI(
    HDC hdc,
    DWORD giFirst,
    DWORD cgi,
    WORD* pgi,   // optional
    INT* piWidths
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool GetCharWidthI(
    IntPtr hdc,   // HDC
    uint giFirst,   // DWORD
    uint cgi,   // DWORD
    IntPtr pgi,   // WORD* optional
    out int piWidths   // INT* out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GetCharWidthI(
    hdc As IntPtr,   ' HDC
    giFirst As UInteger,   ' DWORD
    cgi As UInteger,   ' DWORD
    pgi As IntPtr,   ' WORD* optional
    <Out> ByRef piWidths As Integer   ' INT* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' giFirst : DWORD
' cgi : DWORD
' pgi : WORD* optional
' piWidths : INT* out
Declare PtrSafe Function GetCharWidthI Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal giFirst As Long, _
    ByVal cgi As Long, _
    ByVal pgi As LongPtr, _
    ByRef piWidths As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetCharWidthI = ctypes.windll.gdi32.GetCharWidthI
GetCharWidthI.restype = wintypes.BOOL
GetCharWidthI.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.DWORD,  # giFirst : DWORD
    wintypes.DWORD,  # cgi : DWORD
    ctypes.POINTER(ctypes.c_ushort),  # pgi : WORD* optional
    ctypes.POINTER(ctypes.c_int),  # piWidths : INT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetCharWidthI = Fiddle::Function.new(
  lib['GetCharWidthI'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    -Fiddle::TYPE_INT,  # giFirst : DWORD
    -Fiddle::TYPE_INT,  # cgi : DWORD
    Fiddle::TYPE_VOIDP,  # pgi : WORD* optional
    Fiddle::TYPE_VOIDP,  # piWidths : INT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetCharWidthI(
        hdc: *mut core::ffi::c_void,  // HDC
        giFirst: u32,  // DWORD
        cgi: u32,  // DWORD
        pgi: *mut u16,  // WORD* optional
        piWidths: *mut i32  // INT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool GetCharWidthI(IntPtr hdc, uint giFirst, uint cgi, IntPtr pgi, out int piWidths);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetCharWidthI' -Namespace Win32 -PassThru
# $api::GetCharWidthI(hdc, giFirst, cgi, pgi, piWidths)

#uselib "GDI32.dll"
#func global GetCharWidthI "GetCharWidthI" sptr, sptr, sptr, sptr, sptr
; GetCharWidthI hdc, giFirst, cgi, varptr(pgi), varptr(piWidths)   ; 戻り値は stat
; hdc : HDC -> "sptr"
; giFirst : DWORD -> "sptr"
; cgi : DWORD -> "sptr"
; pgi : WORD* optional -> "sptr"
; piWidths : INT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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