ホーム › Graphics.Gdi › GetTextExtentPointW

GetTextExtentPointW

関数

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

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

シグネチャ

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

BOOL GetTextExtentPointW(
    HDC hdc,
    LPCWSTR lpString,
    INT c,
    SIZE* lpsz
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetTextExtentPointW(
    HDC hdc,
    LPCWSTR lpString,
    INT c,
    SIZE* lpsz
);

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

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

' hdc : HDC
' lpString : LPCWSTR
' c : INT
' lpsz : SIZE* out
Declare PtrSafe Function GetTextExtentPointW Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lpString As LongPtr, _
    ByVal c As Long, _
    ByVal lpsz 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetTextExtentPointW = Fiddle::Function.new(
  lib['GetTextExtentPointW'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # lpString : LPCWSTR
    Fiddle::TYPE_INT,  # c : INT
    Fiddle::TYPE_VOIDP,  # lpsz : SIZE* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "gdi32")]
extern "system" {
    fn GetTextExtentPointW(
        hdc: *mut core::ffi::c_void,  // HDC
        lpString: *const u16,  // LPCWSTR
        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.Unicode)]
public static extern bool GetTextExtentPointW(IntPtr hdc, [MarshalAs(UnmanagedType.LPWStr)] string lpString, int c, IntPtr lpsz);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetTextExtentPointW' -Namespace Win32 -PassThru
# $api::GetTextExtentPointW(hdc, lpString, c, lpsz)

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

出力引数:

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