GetCharWidthFloatA

関数

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

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

シグネチャ

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

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

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功すると、戻り値は 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  (ANSI / -A)
#include <windows.h>

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

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

<DllImport("GDI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetCharWidthFloatA(
    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 GetCharWidthFloatA Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal iFirst As Long, _
    ByVal iLast As Long, _
    ByRef lpBuffer As Single) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetCharWidthFloatA = ctypes.windll.gdi32.GetCharWidthFloatA
GetCharWidthFloatA.restype = wintypes.BOOL
GetCharWidthFloatA.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')
GetCharWidthFloatA = Fiddle::Function.new(
  lib['GetCharWidthFloatA'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    -Fiddle::TYPE_INT,  # iFirst : DWORD
    -Fiddle::TYPE_INT,  # iLast : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : FLOAT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetCharWidthFloatA(
        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.Ansi)]
public static extern bool GetCharWidthFloatA(IntPtr hdc, uint iFirst, uint iLast, out float lpBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetCharWidthFloatA' -Namespace Win32 -PassThru
# $api::GetCharWidthFloatA(hdc, iFirst, iLast, lpBuffer)

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

出力引数:

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