GetCharABCWidthsI

関数

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

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

シグネチャ

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

BOOL GetCharABCWidthsI(
    HDC hdc,
    DWORD giFirst,
    DWORD cgi,
    WORD* pgi,   // optional
    ABC* pabc
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。
giFirst	DWORD	in	現在のフォントにおける連続するグリフインデックスのグループの最初のグリフインデックス。このパラメーターは、pgi パラメーターが NULL の場合にのみ使用されます。
cgi	DWORD	in	グリフインデックスの数。
pgi	WORD*	inoptional	グリフインデックスを含む配列へのポインター。このパラメーターが NULL の場合は、代わりに giFirst パラメーターが使用されます。cgi パラメーターは、この配列内のグリフインデックスの数を指定します。
pabc	ABC*	out	文字幅を論理単位で受け取る ABC 構造体の配列へのポインター。この配列には、cgi パラメーターで指定されたグリフインデックスの数以上の ABC 構造体が含まれている必要があります。

戻り値の型: BOOL

公式ドキュメント

GetCharABCWidthsI 関数は、現在の TrueType フォントから、指定された範囲の連続するグリフインデックスの幅を論理単位で取得します。この関数は TrueType フォントでのみ成功します。

戻り値

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

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

解説(Remarks)

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

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

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

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

TrueType 以外のフォントのグリフインデックスの幅を取得するには、アプリケーションは GetCharWidthI 関数を使用する必要があります。

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

各言語での呼び出し定義

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

BOOL GetCharABCWidthsI(
    HDC hdc,
    DWORD giFirst,
    DWORD cgi,
    WORD* pgi,   // optional
    ABC* pabc
);

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

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

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

import ctypes
from ctypes import wintypes

GetCharABCWidthsI = ctypes.windll.gdi32.GetCharABCWidthsI
GetCharABCWidthsI.restype = wintypes.BOOL
GetCharABCWidthsI.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.DWORD,  # giFirst : DWORD
    wintypes.DWORD,  # cgi : DWORD
    ctypes.POINTER(ctypes.c_ushort),  # pgi : WORD* optional
    ctypes.c_void_p,  # pabc : ABC* out
]

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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