ホーム › Graphics.Gdi › GetTextExtentPoint32A

GetTextExtentPoint32A

関数

文字列を描画した際の幅と高さを取得する。

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

シグネチャ

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

BOOL GetTextExtentPoint32A(
    HDC hdc,
    LPCSTR lpString,
    INT c,
    SIZE* psizl
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。
lpString	LPCSTR	in	テキスト文字列を指定するバッファーへのポインター。文字列の長さは c パラメーターで指定されるため、文字列は null 終端されている必要はありません。
c	INT	in	lpString が指す文字列の長さ。
psizl	SIZE*	out	文字列の寸法を論理単位で受け取る SIZE 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

GetTextExtentPoint32 関数は、指定されたテキスト文字列の幅と高さを計算します。(ANSI)

戻り値

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

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

解説(Remarks)

GetTextExtentPoint32 関数は、現在選択されているフォントを使用して文字列の寸法を計算します。幅と高さは論理単位で、クリッピングを考慮せずに計算されます。

一部のデバイスでは文字のカーニングが行われるため、文字列内の各文字の範囲の合計が、文字列全体の範囲と等しくならない場合があります。

計算される文字列の幅は、SetTextCharacterExtra 関数で設定された文字間隔と、SetTextJustification で設定された両端揃えを考慮します。これは画面表示と印刷の両方に当てはまります。ただし、ExtTextOut で lpDx が設定されている場合、GetTextExtentPoint32 は文字間隔も両端揃えも考慮しません。さらに EMF の場合、印刷結果は常に文字間隔と両端揃えの両方を考慮します。

画面に表示されるテキストを扱う場合、計算される文字列の幅は、SetTextCharacterExtra 関数で設定された文字間隔と、SetTextJustification で設定された両端揃えを考慮します。ただし、ExtTextOut で lpDx が設定されている場合、GetTextExtentPoint32 は文字間隔も両端揃えも考慮しません。ただし、EMF で印刷する場合は次のようになります。

GetTextExtentPoint32 は文字間隔を考慮しますが、印刷結果は文字間隔を無視します。
GetTextExtentPoint32 は両端揃えを無視しますが、印刷結果は両端揃えを考慮します。

この関数はテキストの範囲を返す際、テキストが水平である、つまりエスケープメント (escapement) が常に 0 であると想定します。これはテキストの水平方向と垂直方向の両方の測定に当てはまります。0 以外のエスケープメントを指定するフォントを使用していても、この関数はテキストの範囲を計算する際にその角度を使用しません。アプリケーションは明示的に変換を行う必要があります。ただし、グラフィックスモードが GM_ADVANCED に設定され、文字の向きが印刷の向きから 90 度回転している場合、この関数が返す値はこの規則に従いません。ある文字列について文字の向きと印刷の向きが一致する場合、この関数は SIZE 構造体に文字列の寸法を { cx : 116, cy : 18 } として返します。同じ文字列について文字の向きと印刷の向きが 90 度異なる場合、この関数は SIZE 構造体に文字列の寸法を { cx : 18, cy : 116 } として返します。

GetTextExtentPoint32 は、テキスト文字列の高さを計算する際に "\n" (改行) や "\r\n" (キャリッジリターンと改行) の文字を考慮しません。

例

例については、Drawing Text from Different Fonts on the Same Line を参照してください。

メモ

wingdi.h ヘッダーは、GetTextExtentPoint32 を、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 GetTextExtentPoint32A(
    HDC hdc,
    LPCSTR lpString,
    INT c,
    SIZE* psizl
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool GetTextExtentPoint32A(
    IntPtr hdc,   // HDC
    [MarshalAs(UnmanagedType.LPStr)] string lpString,   // LPCSTR
    int c,   // INT
    IntPtr psizl   // SIZE* out
);

<DllImport("GDI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetTextExtentPoint32A(
    hdc As IntPtr,   ' HDC
    <MarshalAs(UnmanagedType.LPStr)> lpString As String,   ' LPCSTR
    c As Integer,   ' INT
    psizl As IntPtr   ' SIZE* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' lpString : LPCSTR
' c : INT
' psizl : SIZE* out
Declare PtrSafe Function GetTextExtentPoint32A Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lpString As String, _
    ByVal c As Long, _
    ByVal psizl As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetTextExtentPoint32A = ctypes.windll.gdi32.GetTextExtentPoint32A
GetTextExtentPoint32A.restype = wintypes.BOOL
GetTextExtentPoint32A.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.LPCSTR,  # lpString : LPCSTR
    ctypes.c_int,  # c : INT
    ctypes.c_void_p,  # psizl : SIZE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetTextExtentPoint32A = Fiddle::Function.new(
  lib['GetTextExtentPoint32A'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # lpString : LPCSTR
    Fiddle::TYPE_INT,  # c : INT
    Fiddle::TYPE_VOIDP,  # psizl : SIZE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetTextExtentPoint32A(
        hdc: *mut core::ffi::c_void,  // HDC
        lpString: *const u8,  // LPCSTR
        c: i32,  // INT
        psizl: *mut SIZE  // SIZE* 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 GetTextExtentPoint32A(IntPtr hdc, [MarshalAs(UnmanagedType.LPStr)] string lpString, int c, IntPtr psizl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetTextExtentPoint32A' -Namespace Win32 -PassThru
# $api::GetTextExtentPoint32A(hdc, lpString, c, psizl)

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

出力引数:

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