GetTextMetricsA

関数

現在選択中のフォントの文字計量情報を取得する(ANSI版)。

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

シグネチャ

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

BOOL GetTextMetricsA(
    HDC hdc,
    TEXTMETRICA* lptm
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。
lptm	TEXTMETRICA*	out	テキストメトリックを受け取る TEXTMETRIC 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

GetTextMetrics 関数は、現在選択されているフォントのメトリックを指定したバッファに格納します。(GetTextMetricsA)

戻り値

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

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

解説(Remarks)

フォントが TrueType フォントかどうかを判定するには、まずそのフォントを DC に選択し、次に GetTextMetrics を呼び出して、TEXTMETRIC.tmPitchAndFamily に TMPF_TRUETYPE が設定されているかを確認します。GetDC は初期化されていない DC を返し、その既定フォントは "System"(ビットマップフォント)であることに注意してください。そのため、DC にフォントを選択する必要があります。

Examples

例については、Using Keyboard Input の「Displaying Keyboard Input」、または Drawing Text from Different Fonts on the Same Line を参照してください。

メモ

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

BOOL GetTextMetricsA(
    HDC hdc,
    TEXTMETRICA* lptm
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool GetTextMetricsA(
    IntPtr hdc,   // HDC
    IntPtr lptm   // TEXTMETRICA* out
);

<DllImport("GDI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetTextMetricsA(
    hdc As IntPtr,   ' HDC
    lptm As IntPtr   ' TEXTMETRICA* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' lptm : TEXTMETRICA* out
Declare PtrSafe Function GetTextMetricsA Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lptm As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetTextMetricsA = ctypes.windll.gdi32.GetTextMetricsA
GetTextMetricsA.restype = wintypes.BOOL
GetTextMetricsA.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_void_p,  # lptm : TEXTMETRICA* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetTextMetricsA = Fiddle::Function.new(
  lib['GetTextMetricsA'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # lptm : TEXTMETRICA* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetTextMetricsA(
        hdc: *mut core::ffi::c_void,  // HDC
        lptm: *mut TEXTMETRICA  // TEXTMETRICA* 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 GetTextMetricsA(IntPtr hdc, IntPtr lptm);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetTextMetricsA' -Namespace Win32 -PassThru
# $api::GetTextMetricsA(hdc, lptm)

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

出力引数:

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