ホーム › Graphics.Gdi › GetTextExtentPointA

GetTextExtentPointA

関数

文字列を描画した際の寸法を取得する。

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

シグネチャ

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

BOOL GetTextExtentPointA(
    HDC hdc,
    LPCSTR lpString,
    INT c,
    SIZE* lpsz
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

GetTextExtentPoint 関数は、現在選択されているフォントを使用して文字列の寸法を計算します。幅と高さは、クリッピングを考慮せずに論理単位で計算されます。また、この関数はテキストが水平である、つまりエスケープメント (escapement) が常に 0 であると想定します。これはテキストの水平方向と垂直方向の両方の測定に当てはまります。0 以外のエスケープメントを指定するフォントを使用している場合でも、この関数はテキストエクステントの計算時にその角度を使用しません。アプリケーションは明示的に変換する必要があります。

一部のデバイスは文字をカーニングするため、文字列内の各文字のエクステントの合計が、文字列のエクステントと等しくならない場合があります。

計算される文字列の幅には、SetTextCharacterExtra 関数によって設定された文字間隔が考慮されます。

メモ

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

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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