GetCharWidthA

関数

指定範囲の文字の幅を取得する。

DLLGDI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// GDI32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetCharWidthA(
    HDC hdc,
    DWORD iFirst,
    DWORD iLast,
    INT* lpBuffer
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。
iFirst	DWORD	in	連続する文字グループの最初の文字。
iLast	DWORD	in	連続する文字グループの最後の文字。指定した最初の文字より前であってはなりません。
lpBuffer	INT*	out	文字の幅を論理座標で受け取るバッファーへのポインター。

戻り値の型: BOOL

公式ドキュメント

GetCharWidth 関数は、現在のフォントから指定した範囲の連続する文字の幅を論理座標で取得します。(ANSI)

戻り値

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

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

解説(Remarks)

GetCharWidth は TrueType フォントには使用できません。TrueType フォントの文字幅を取得するには、GetCharABCWidths を使用してください。

範囲は両端を含みます。つまり、返される幅には iFirstChar パラメーターと iLastChar パラメーターで指定した文字の幅が含まれます。

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

メモ

wingdi.h ヘッダーは GetCharWidth をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// GDI32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetCharWidthA(
    HDC hdc,
    DWORD iFirst,
    DWORD iLast,
    INT* lpBuffer
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool GetCharWidthA(
    IntPtr hdc,   // HDC
    uint iFirst,   // DWORD
    uint iLast,   // DWORD
    out int lpBuffer   // INT* out
);

<DllImport("GDI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetCharWidthA(
    hdc As IntPtr,   ' HDC
    iFirst As UInteger,   ' DWORD
    iLast As UInteger,   ' DWORD
    <Out> ByRef lpBuffer As Integer   ' INT* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' iFirst : DWORD
' iLast : DWORD
' lpBuffer : INT* out
Declare PtrSafe Function GetCharWidthA Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal iFirst As Long, _
    ByVal iLast As Long, _
    ByRef lpBuffer As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetCharWidthA = ctypes.windll.gdi32.GetCharWidthA
GetCharWidthA.restype = wintypes.BOOL
GetCharWidthA.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.DWORD,  # iFirst : DWORD
    wintypes.DWORD,  # iLast : DWORD
    ctypes.POINTER(ctypes.c_int),  # lpBuffer : INT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetCharWidthA = Fiddle::Function.new(
  lib['GetCharWidthA'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    -Fiddle::TYPE_INT,  # iFirst : DWORD
    -Fiddle::TYPE_INT,  # iLast : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : INT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetCharWidthA(
        hdc: *mut core::ffi::c_void,  // HDC
        iFirst: u32,  // DWORD
        iLast: u32,  // DWORD
        lpBuffer: *mut i32  // INT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", CharSet = CharSet.Ansi)]
public static extern bool GetCharWidthA(IntPtr hdc, uint iFirst, uint iLast, out int lpBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetCharWidthA' -Namespace Win32 -PassThru
# $api::GetCharWidthA(hdc, iFirst, iLast, lpBuffer)

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

出力引数:

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