ホーム › Graphics.Gdi › GetTextExtentPointI

GetTextExtentPointI

関数

グリフインデックス列の描画寸法を取得する。

DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// GDI32.dll
#include <windows.h>

BOOL GetTextExtentPointI(
    HDC hdc,
    WORD* pgiIn,
    INT cgi,
    SIZE* psize
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。
pgiIn	WORD*	in	グリフインデックスの配列へのポインター。
cgi	INT	in	グリフインデックスの数を指定します。
psize	SIZE*	out	文字列の寸法を論理単位で受け取る SIZE 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

GetTextExtentPointI 関数は、指定されたグリフインデックスの配列の幅と高さを計算します。

戻り値

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

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

解説(Remarks)

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

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

一部のデバイスは文字のカーニングを行うため、個々のグリフインデックスの範囲の合計が、グリフインデックスの配列全体の範囲と等しくならない場合があります。

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// GDI32.dll
#include <windows.h>

BOOL GetTextExtentPointI(
    HDC hdc,
    WORD* pgiIn,
    INT cgi,
    SIZE* psize
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool GetTextExtentPointI(
    IntPtr hdc,   // HDC
    ref ushort pgiIn,   // WORD*
    int cgi,   // INT
    IntPtr psize   // SIZE* out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GetTextExtentPointI(
    hdc As IntPtr,   ' HDC
    ByRef pgiIn As UShort,   ' WORD*
    cgi As Integer,   ' INT
    psize As IntPtr   ' SIZE* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' pgiIn : WORD*
' cgi : INT
' psize : SIZE* out
Declare PtrSafe Function GetTextExtentPointI Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByRef pgiIn As Integer, _
    ByVal cgi As Long, _
    ByVal psize As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetTextExtentPointI = ctypes.windll.gdi32.GetTextExtentPointI
GetTextExtentPointI.restype = wintypes.BOOL
GetTextExtentPointI.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.POINTER(ctypes.c_ushort),  # pgiIn : WORD*
    ctypes.c_int,  # cgi : INT
    ctypes.c_void_p,  # psize : SIZE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetTextExtentPointI = Fiddle::Function.new(
  lib['GetTextExtentPointI'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # pgiIn : WORD*
    Fiddle::TYPE_INT,  # cgi : INT
    Fiddle::TYPE_VOIDP,  # psize : SIZE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetTextExtentPointI(
        hdc: *mut core::ffi::c_void,  // HDC
        pgiIn: *mut u16,  // WORD*
        cgi: i32,  // INT
        psize: *mut SIZE  // SIZE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool GetTextExtentPointI(IntPtr hdc, ref ushort pgiIn, int cgi, IntPtr psize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetTextExtentPointI' -Namespace Win32 -PassThru
# $api::GetTextExtentPointI(hdc, pgiIn, cgi, psize)

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

出力引数:

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