ホーム › Graphics.Gdi › GetTextExtentExPointA

GetTextExtentExPointA

関数

指定幅に収まる文字数と寸法を取得する。

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

シグネチャ

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

BOOL GetTextExtentExPointA(
    HDC hdc,
    LPCSTR lpszString,
    INT cchString,
    INT nMaxExtent,
    INT* lpnFit,   // optional
    INT* lpnDx,   // optional
    SIZE* lpSize
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドルです。
lpszString	LPCSTR	in	幅を取得する対象の、null で終端された文字列へのポインターです。
cchString	INT	in	lpszStr パラメーターが指す文字列の文字数です。ANSI 呼び出しではバイト単位の文字列長を、Unicode 呼び出しでは WORD 単位の文字列長を指定します。ANSI 関数では、SBCS コードページの文字は 1 文字あたり 1 バイトを使用しますが、DBCS コードページのほとんどの文字は 2 バイトを使用します。Unicode 関数では、現在定義されているほとんどの Unicode 文字(基本多言語面 (BMP) に含まれる文字)は 1 WORD ですが、Unicode サロゲートは 2 WORD です。
nMaxExtent	INT	in	整形された文字列の許容される最大幅を、論理単位で指定します。
lpnFit	INT*	outoptional	nMaxExtent パラメーターで指定された領域に収まる最大文字数を受け取る整数へのポインターです。lpnFit パラメーターが NULL の場合、nMaxExtent パラメーターは無視されます。
lpnDx	INT*	outoptional	部分文字列の幅を受け取る整数配列へのポインターです。配列の各要素は、文字列の先頭から nMaxExtent パラメーターで指定された領域に収まる各文字までの距離を、論理単位で表します。配列全体が内部的に使用されるため、この配列には少なくとも cchString パラメーターで指定された文字数と同じ数の要素が必要です。関数は、lpnFit パラメーターで指定された文字数分だけ有効な幅を配列に格納します。配列の残りの値は無視してください。alpDx が NULL の場合、関数は部分文字列の幅を計算しません。複数の文字の並びが任意の数のグリフで表現される可能性がある複雑なスクリプトでは、alpDx 配列内の lpnFit パラメーターで指定された数までの値が、コードポイントと 1 対 1 で対応します。この場合も、alpDx 配列の残りの値は無視してください。
lpSize	SIZE*	out	文字列の寸法を論理単位で受け取る SIZE 構造体へのポインターです。このパラメーターを NULL にすることはできません。

戻り値の型: BOOL

公式ドキュメント

GetTextExtentExPoint 関数は、指定した領域に収まる文字数を指定された文字列から取得し、それらの各文字のテキストの幅を配列に格納します。(ANSI)

戻り値

関数が成功すると、0 以外の値が返されます。

関数が失敗すると、0 が返されます。

解説(Remarks)

lpnFit と alpDx の両方のパラメーターが NULL の場合、GetTextExtentExPoint 関数の呼び出しは GetTextExtentPoint 関数の呼び出しと同等です。

GetTextExtentExPoint の ANSI バージョンでは、lpDx 配列は lpString 内のバイト数と同じ数の INT 値を持ちます。DBCS 文字の 2 バイトに対応する INT 値は、いずれもその合成文字全体の幅になります。

なお、GetTextExtentExPoint の alpDx 値は、ExtTextOut の lpDx 値とは異なります。alpDx 値を lpDx で使用するには、まずそれらを処理する必要があります。

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

この関数は、文字列内の連続する各文字の幅を返します。これらを論理単位に丸めると、各文字の幅を論理単位に丸めて返す GetCharWidth から返される結果とは異なる結果が得られます。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetTextExtentExPointA(
    HDC hdc,
    LPCSTR lpszString,
    INT cchString,
    INT nMaxExtent,
    INT* lpnFit,   // optional
    INT* lpnDx,   // optional
    SIZE* lpSize
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool GetTextExtentExPointA(
    IntPtr hdc,   // HDC
    [MarshalAs(UnmanagedType.LPStr)] string lpszString,   // LPCSTR
    int cchString,   // INT
    int nMaxExtent,   // INT
    IntPtr lpnFit,   // INT* optional, out
    IntPtr lpnDx,   // INT* optional, out
    IntPtr lpSize   // SIZE* out
);

<DllImport("GDI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetTextExtentExPointA(
    hdc As IntPtr,   ' HDC
    <MarshalAs(UnmanagedType.LPStr)> lpszString As String,   ' LPCSTR
    cchString As Integer,   ' INT
    nMaxExtent As Integer,   ' INT
    lpnFit As IntPtr,   ' INT* optional, out
    lpnDx As IntPtr,   ' INT* optional, out
    lpSize As IntPtr   ' SIZE* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' lpszString : LPCSTR
' cchString : INT
' nMaxExtent : INT
' lpnFit : INT* optional, out
' lpnDx : INT* optional, out
' lpSize : SIZE* out
Declare PtrSafe Function GetTextExtentExPointA Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lpszString As String, _
    ByVal cchString As Long, _
    ByVal nMaxExtent As Long, _
    ByVal lpnFit As LongPtr, _
    ByVal lpnDx As LongPtr, _
    ByVal lpSize As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetTextExtentExPointA = ctypes.windll.gdi32.GetTextExtentExPointA
GetTextExtentExPointA.restype = wintypes.BOOL
GetTextExtentExPointA.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.LPCSTR,  # lpszString : LPCSTR
    ctypes.c_int,  # cchString : INT
    ctypes.c_int,  # nMaxExtent : INT
    ctypes.POINTER(ctypes.c_int),  # lpnFit : INT* optional, out
    ctypes.POINTER(ctypes.c_int),  # lpnDx : INT* optional, out
    ctypes.c_void_p,  # lpSize : SIZE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetTextExtentExPointA = Fiddle::Function.new(
  lib['GetTextExtentExPointA'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # lpszString : LPCSTR
    Fiddle::TYPE_INT,  # cchString : INT
    Fiddle::TYPE_INT,  # nMaxExtent : INT
    Fiddle::TYPE_VOIDP,  # lpnFit : INT* optional, out
    Fiddle::TYPE_VOIDP,  # lpnDx : INT* optional, out
    Fiddle::TYPE_VOIDP,  # lpSize : SIZE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetTextExtentExPointA(
        hdc: *mut core::ffi::c_void,  // HDC
        lpszString: *const u8,  // LPCSTR
        cchString: i32,  // INT
        nMaxExtent: i32,  // INT
        lpnFit: *mut i32,  // INT* optional, out
        lpnDx: *mut i32,  // INT* optional, out
        lpSize: *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 GetTextExtentExPointA(IntPtr hdc, [MarshalAs(UnmanagedType.LPStr)] string lpszString, int cchString, int nMaxExtent, IntPtr lpnFit, IntPtr lpnDx, IntPtr lpSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetTextExtentExPointA' -Namespace Win32 -PassThru
# $api::GetTextExtentExPointA(hdc, lpszString, cchString, nMaxExtent, lpnFit, lpnDx, lpSize)

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

出力引数:

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