Win32 API 日本語リファレンス
ホームGraphics.Gdi › GetTextExtentPoint32W

GetTextExtentPoint32W

関数
文字列を描画した際の幅と高さを取得する。
DLLGDI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL GetTextExtentPoint32W(
    HDC hdc,
    LPCWSTR lpString,
    INT c,
    SIZE* psizl
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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

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

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

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

例については、同じ行に異なるフォントでテキストを描画するを参照してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetTextExtentPoint32W(
    HDC hdc,
    LPCWSTR lpString,
    INT c,
    SIZE* psizl
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool GetTextExtentPoint32W(
    IntPtr hdc,   // HDC
    [MarshalAs(UnmanagedType.LPWStr)] string lpString,   // LPCWSTR
    int c,   // INT
    IntPtr psizl   // SIZE* out
);
<DllImport("GDI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetTextExtentPoint32W(
    hdc As IntPtr,   ' HDC
    <MarshalAs(UnmanagedType.LPWStr)> lpString As String,   ' LPCWSTR
    c As Integer,   ' INT
    psizl As IntPtr   ' SIZE* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hdc : HDC
' lpString : LPCWSTR
' c : INT
' psizl : SIZE* out
Declare PtrSafe Function GetTextExtentPoint32W Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lpString As LongPtr, _
    ByVal c As Long, _
    ByVal psizl 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

GetTextExtentPoint32W = ctypes.windll.gdi32.GetTextExtentPoint32W
GetTextExtentPoint32W.restype = wintypes.BOOL
GetTextExtentPoint32W.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.LPCWSTR,  # lpString : LPCWSTR
    ctypes.c_int,  # c : INT
    ctypes.c_void_p,  # psizl : SIZE* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetTextExtentPoint32W = Fiddle::Function.new(
  lib['GetTextExtentPoint32W'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # lpString : LPCWSTR
    Fiddle::TYPE_INT,  # c : INT
    Fiddle::TYPE_VOIDP,  # psizl : SIZE* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "gdi32")]
extern "system" {
    fn GetTextExtentPoint32W(
        hdc: *mut core::ffi::c_void,  // HDC
        lpString: *const u16,  // LPCWSTR
        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.Unicode)]
public static extern bool GetTextExtentPoint32W(IntPtr hdc, [MarshalAs(UnmanagedType.LPWStr)] string lpString, int c, IntPtr psizl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetTextExtentPoint32W' -Namespace Win32 -PassThru
# $api::GetTextExtentPoint32W(hdc, lpString, c, psizl)
#uselib "GDI32.dll"
#func global GetTextExtentPoint32W "GetTextExtentPoint32W" wptr, wptr, wptr, wptr
; GetTextExtentPoint32W hdc, lpString, c, varptr(psizl)   ; 戻り値は stat
; hdc : HDC -> "wptr"
; lpString : LPCWSTR -> "wptr"
; c : INT -> "wptr"
; psizl : SIZE* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "GDI32.dll"
#cfunc global GetTextExtentPoint32W "GetTextExtentPoint32W" sptr, wstr, int, var
; res = GetTextExtentPoint32W(hdc, lpString, c, psizl)
; hdc : HDC -> "sptr"
; lpString : LPCWSTR -> "wstr"
; c : INT -> "int"
; psizl : SIZE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetTextExtentPoint32W(HDC hdc, LPCWSTR lpString, INT c, SIZE* psizl)
#uselib "GDI32.dll"
#cfunc global GetTextExtentPoint32W "GetTextExtentPoint32W" intptr, wstr, int, var
; res = GetTextExtentPoint32W(hdc, lpString, c, psizl)
; hdc : HDC -> "intptr"
; lpString : LPCWSTR -> "wstr"
; c : INT -> "int"
; psizl : SIZE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procGetTextExtentPoint32W = gdi32.NewProc("GetTextExtentPoint32W")
)

// hdc (HDC), lpString (LPCWSTR), c (INT), psizl (SIZE* out)
r1, _, err := procGetTextExtentPoint32W.Call(
	uintptr(hdc),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpString))),
	uintptr(c),
	uintptr(psizl),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetTextExtentPoint32W(
  hdc: THandle;   // HDC
  lpString: PWideChar;   // LPCWSTR
  c: Integer;   // INT
  psizl: Pointer   // SIZE* out
): BOOL; stdcall;
  external 'GDI32.dll' name 'GetTextExtentPoint32W';
result := DllCall("GDI32\GetTextExtentPoint32W"
    , "Ptr", hdc   ; HDC
    , "WStr", lpString   ; LPCWSTR
    , "Int", c   ; INT
    , "Ptr", psizl   ; SIZE* out
    , "Int")   ; return: BOOL
●GetTextExtentPoint32W(hdc, lpString, c, psizl) = DLL("GDI32.dll", "bool GetTextExtentPoint32W(void*, char*, int, void*)")
# 呼び出し: GetTextExtentPoint32W(hdc, lpString, c, psizl)
# hdc : HDC -> "void*"
# lpString : LPCWSTR -> "char*"
# c : INT -> "int"
# psizl : SIZE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "gdi32" fn GetTextExtentPoint32W(
    hdc: ?*anyopaque, // HDC
    lpString: [*c]const u16, // LPCWSTR
    c: i32, // INT
    psizl: [*c]SIZE // SIZE* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetTextExtentPoint32W(
    hdc: pointer,  # HDC
    lpString: WideCString,  # LPCWSTR
    c: int32,  # INT
    psizl: ptr SIZE  # SIZE* out
): int32 {.importc: "GetTextExtentPoint32W", stdcall, dynlib: "GDI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "gdi32");
extern(Windows)
int GetTextExtentPoint32W(
    void* hdc,   // HDC
    const(wchar)* lpString,   // LPCWSTR
    int c,   // INT
    SIZE* psizl   // SIZE* out
);
ccall((:GetTextExtentPoint32W, "GDI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, Int32, Ptr{SIZE}),
      hdc, lpString, c, psizl)
# hdc : HDC -> Ptr{Cvoid}
# lpString : LPCWSTR -> Cwstring
# c : INT -> Int32
# psizl : SIZE* out -> Ptr{SIZE}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetTextExtentPoint32W(
    void* hdc,
    const uint16_t* lpString,
    int32_t c,
    void* psizl);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.GetTextExtentPoint32W(hdc, lpString, c, psizl)
-- hdc : HDC
-- lpString : LPCWSTR
-- c : INT
-- psizl : SIZE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const GetTextExtentPoint32W = lib.func('__stdcall', 'GetTextExtentPoint32W', 'int32_t', ['void *', 'str16', 'int32_t', 'void *']);
// GetTextExtentPoint32W(hdc, lpString, c, psizl)
// hdc : HDC -> 'void *'
// lpString : LPCWSTR -> 'str16'
// c : INT -> 'int32_t'
// psizl : SIZE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  GetTextExtentPoint32W: { parameters: ["pointer", "buffer", "i32", "pointer"], result: "i32" },
});
// lib.symbols.GetTextExtentPoint32W(hdc, lpString, c, psizl)
// hdc : HDC -> "pointer"
// lpString : LPCWSTR -> "buffer"
// c : INT -> "i32"
// psizl : SIZE* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetTextExtentPoint32W(
    void* hdc,
    const uint16_t* lpString,
    int32_t c,
    void* psizl);
C, "GDI32.dll");
// $ffi->GetTextExtentPoint32W(hdc, lpString, c, psizl);
// hdc : HDC
// lpString : LPCWSTR
// c : INT
// psizl : SIZE* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Gdi32 extends StdCallLibrary {
    Gdi32 INSTANCE = Native.load("gdi32", Gdi32.class, W32APIOptions.UNICODE_OPTIONS);
    boolean GetTextExtentPoint32W(
        Pointer hdc,   // HDC
        WString lpString,   // LPCWSTR
        int c,   // INT
        Pointer psizl   // SIZE* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("gdi32")]
lib LibGDI32
  fun GetTextExtentPoint32W = GetTextExtentPoint32W(
    hdc : Void*,   # HDC
    lpString : UInt16*,   # LPCWSTR
    c : Int32,   # INT
    psizl : SIZE*   # SIZE* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetTextExtentPoint32WNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Int32, Pointer<Void>);
typedef GetTextExtentPoint32WDart = int Function(Pointer<Void>, Pointer<Utf16>, int, Pointer<Void>);
final GetTextExtentPoint32W = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<GetTextExtentPoint32WNative, GetTextExtentPoint32WDart>('GetTextExtentPoint32W');
// hdc : HDC -> Pointer<Void>
// lpString : LPCWSTR -> Pointer<Utf16>
// c : INT -> Int32
// psizl : SIZE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetTextExtentPoint32W(
  hdc: THandle;   // HDC
  lpString: PWideChar;   // LPCWSTR
  c: Integer;   // INT
  psizl: Pointer   // SIZE* out
): BOOL; stdcall;
  external 'GDI32.dll' name 'GetTextExtentPoint32W';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetTextExtentPoint32W"
  c_GetTextExtentPoint32W :: Ptr () -> CWString -> Int32 -> Ptr () -> IO CInt
-- hdc : HDC -> Ptr ()
-- lpString : LPCWSTR -> CWString
-- c : INT -> Int32
-- psizl : SIZE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let gettextextentpoint32w =
  foreign "GetTextExtentPoint32W"
    ((ptr void) @-> (ptr uint16_t) @-> int32_t @-> (ptr void) @-> returning int32_t)
(* hdc : HDC -> (ptr void) *)
(* lpString : LPCWSTR -> (ptr uint16_t) *)
(* c : INT -> int32_t *)
(* psizl : SIZE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("GetTextExtentPoint32W" get-text-extent-point32-w :convention :stdcall) :int32
  (hdc :pointer)   ; HDC
  (lp-string (:string :encoding :utf-16le))   ; LPCWSTR
  (c :int32)   ; INT
  (psizl :pointer))   ; SIZE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetTextExtentPoint32W = Win32::API::More->new('GDI32',
    'BOOL GetTextExtentPoint32W(HANDLE hdc, LPCWSTR lpString, int c, LPVOID psizl)');
# my $ret = $GetTextExtentPoint32W->Call($hdc, $lpString, $c, $psizl);
# hdc : HDC -> HANDLE
# lpString : LPCWSTR -> LPCWSTR
# c : INT -> int
# psizl : SIZE* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
公式の関連項目
使用する型