GetTextMetricsW

関数

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

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

シグネチャ

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

BOOL GetTextMetricsW(
    HDC hdc,
    TEXTMETRICW* lptm
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

例

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

メモ

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

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

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

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

' hdc : HDC
' lptm : TEXTMETRICW* out
Declare PtrSafe Function GetTextMetricsW Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lptm 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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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