ホーム › Graphics.Gdi › GetCharABCWidthsFloatW

GetCharABCWidthsFloatW

関数

文字のABC幅を小数値で取得する。

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

シグネチャ

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

BOOL GetCharABCWidthsFloatW(
    HDC hdc,
    DWORD iFirst,
    DWORD iLast,
    ABCFLOAT* lpABC
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドルです。
iFirst	DWORD	in	ABC 幅を取得する連続した文字グループのうち、先頭の文字のコードポイントを指定します。
iLast	DWORD	in	ABC 幅を取得する連続した文字グループのうち、末尾の文字のコードポイントを指定します。この範囲には末尾の文字自体も含まれます。指定した末尾の文字が指定した先頭の文字より前にある場合は、エラーが返されます。
lpABC	ABCFLOAT*	out	文字の幅を論理単位で受け取る ABCFLOAT 構造体の配列へのポインターです。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

TrueType フォントについてのみ幅を返す GetCharABCWidths 関数とは異なり、GetCharABCWidthsFloat 関数は任意のフォントについて幅を取得します。この関数が返す幅は IEEE 浮動小数点形式です。

現在のワールド座標からデバイス座標への変換が単位変換でない場合、デバイス空間での対応する値が整数であっても、返される幅は整数でない値になることがあります。

A スペースは、グリフを配置する前に現在位置に加算される距離です。B スペースは、グリフの黒い部分の幅です。C スペースは、グリフの右側に余白を設けるために現在位置に加算される距離です。送り幅の合計は A+B+C で表されます。

ABC スペースは、選択されているフォントの文字ベースラインに沿って測定されます。

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

メモ

wingdi.h ヘッダーは、GetCharABCWidthsFloat を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立なエイリアスと、エンコーディング中立でないコードを混在させて使用すると、不整合が生じてコンパイルエラーや実行時エラーを引き起こすことがあります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetCharABCWidthsFloatW(
    HDC hdc,
    DWORD iFirst,
    DWORD iLast,
    ABCFLOAT* lpABC
);

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

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

' hdc : HDC
' iFirst : DWORD
' iLast : DWORD
' lpABC : ABCFLOAT* out
Declare PtrSafe Function GetCharABCWidthsFloatW Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal iFirst As Long, _
    ByVal iLast 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

GetCharABCWidthsFloatW = ctypes.windll.gdi32.GetCharABCWidthsFloatW
GetCharABCWidthsFloatW.restype = wintypes.BOOL
GetCharABCWidthsFloatW.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.DWORD,  # iFirst : DWORD
    wintypes.DWORD,  # iLast : DWORD
    ctypes.c_void_p,  # lpABC : ABCFLOAT* out
]

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "gdi32")]
extern "system" {
    fn GetCharABCWidthsFloatW(
        hdc: *mut core::ffi::c_void,  // HDC
        iFirst: u32,  // DWORD
        iLast: u32,  // DWORD
        lpABC: *mut ABCFLOAT  // ABCFLOAT* 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 GetCharABCWidthsFloatW(IntPtr hdc, uint iFirst, uint iLast, IntPtr lpABC);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetCharABCWidthsFloatW' -Namespace Win32 -PassThru
# $api::GetCharABCWidthsFloatW(hdc, iFirst, iLast, lpABC)

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

出力引数:

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