GetCharABCWidthsW

関数

TrueTypeフォントの文字のABC幅を取得する。

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

シグネチャ

// GDI32.dll  (Unicode / -W)
#include <windows.h>

BOOL GetCharABCWidthsW(
    HDC hdc,
    DWORD wFirst,
    DWORD wLast,
    ABC* lpABC
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。
wFirst	DWORD	in	現在のフォントの連続する文字グループ内の最初の文字。
wLast	DWORD	in	現在のフォントの連続する文字グループ内の最後の文字。
lpABC	ABC*	out	文字幅を論理単位で受け取る ABC 構造体の配列へのポインター。この配列には、uFirstChar および uLastChar パラメーターで指定された範囲内の文字数と少なくとも同じ数の ABC 構造体が含まれている必要があります。

戻り値の型: BOOL

公式ドキュメント

GetCharABCWidths 関数は、現在の TrueType フォントから、指定した範囲内の連続する文字の幅を論理単位で取得します。この関数は TrueType フォントでのみ成功します。(Unicode)

戻り値

関数が成功した場合、戻り値は 0 以外です。

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

解説(Remarks)

TrueType ラスタライザーは、特定のポイントサイズが選択された後に ABC 文字間隔を提供します。A 間隔は、グリフを配置する前に現在位置に加算される距離です。B 間隔は、グリフの黒い部分の幅です。C 間隔は、グリフの右側に空白を設けるために現在位置に加算される距離です。送り幅の合計は A+B+C で指定されます。

GetCharABCWidths 関数がある文字について負の A 幅または C 幅を取得した場合、その文字にはアンダーハングまたはオーバーハングが含まれます。

ABC 幅をフォントのデザイン単位に変換するには、アプリケーションは OUTLINETEXTMETRIC 構造体の otmEMSquare メンバーに格納されている値を使用する必要があります。この値は、GetOutlineTextMetrics 関数を呼び出すことで取得できます。

現在選択されているフォントの範囲外の文字には、既定文字の ABC 幅が使用されます。

TrueType 以外のフォントの文字幅を取得するには、アプリケーションは GetCharWidth 関数を使用する必要があります。

メモ

wingdi.h ヘッダーは、GetCharABCWidths を、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  (Unicode / -W)
#include <windows.h>

BOOL GetCharABCWidthsW(
    HDC hdc,
    DWORD wFirst,
    DWORD wLast,
    ABC* lpABC
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool GetCharABCWidthsW(
    IntPtr hdc,   // HDC
    uint wFirst,   // DWORD
    uint wLast,   // DWORD
    IntPtr lpABC   // ABC* out
);

<DllImport("GDI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetCharABCWidthsW(
    hdc As IntPtr,   ' HDC
    wFirst As UInteger,   ' DWORD
    wLast As UInteger,   ' DWORD
    lpABC As IntPtr   ' ABC* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' wFirst : DWORD
' wLast : DWORD
' lpABC : ABC* out
Declare PtrSafe Function GetCharABCWidthsW Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal wFirst As Long, _
    ByVal wLast As Long, _
    ByVal lpABC As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetCharABCWidthsW = ctypes.windll.gdi32.GetCharABCWidthsW
GetCharABCWidthsW.restype = wintypes.BOOL
GetCharABCWidthsW.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.DWORD,  # wFirst : DWORD
    wintypes.DWORD,  # wLast : DWORD
    ctypes.c_void_p,  # lpABC : ABC* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetCharABCWidthsW = Fiddle::Function.new(
  lib['GetCharABCWidthsW'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    -Fiddle::TYPE_INT,  # wFirst : DWORD
    -Fiddle::TYPE_INT,  # wLast : DWORD
    Fiddle::TYPE_VOIDP,  # lpABC : ABC* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", CharSet = CharSet.Unicode)]
public static extern bool GetCharABCWidthsW(IntPtr hdc, uint wFirst, uint wLast, IntPtr lpABC);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetCharABCWidthsW' -Namespace Win32 -PassThru
# $api::GetCharABCWidthsW(hdc, wFirst, wLast, lpABC)

#uselib "GDI32.dll"
#func global GetCharABCWidthsW "GetCharABCWidthsW" wptr, wptr, wptr, wptr
; GetCharABCWidthsW hdc, wFirst, wLast, varptr(lpABC)   ; 戻り値は stat
; hdc : HDC -> "wptr"
; wFirst : DWORD -> "wptr"
; wLast : DWORD -> "wptr"
; lpABC : ABC* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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