GetCharWidthFloatW

関数

指定範囲の文字幅を小数値で取得する。

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

シグネチャ

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

BOOL GetCharWidthFloatW(
    HDC hdc,
    DWORD iFirst,
    DWORD iLast,
    FLOAT* lpBuffer
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドルです。
iFirst	DWORD	in	連続する文字グループの最初の文字のコードポイントです。
iLast	DWORD	in	連続する文字グループの最後の文字のコードポイントです。
lpBuffer	FLOAT*	out	文字幅を論理単位で受け取るバッファーへのポインターです。

戻り値の型: BOOL

公式ドキュメント

GetCharWidthFloat 関数は、現在のフォントから指定された範囲の連続する文字の小数幅を取得します。(Unicode)

戻り値

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

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

解説(Remarks)

返される幅は 32 ビットの IEEE 浮動小数点形式です。(幅は文字のベースラインに沿って測定されます。)

iFirstChar パラメーターに文字 a を指定し、iLastChar パラメーターに文字 z を指定した場合、GetCharWidthFloat はすべての小文字の幅を取得します。

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

メモ

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

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

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

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

' hdc : HDC
' iFirst : DWORD
' iLast : DWORD
' lpBuffer : FLOAT* out
Declare PtrSafe Function GetCharWidthFloatW Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal iFirst As Long, _
    ByVal iLast As Long, _
    ByRef lpBuffer As Single) 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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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