ホーム › Graphics.Gdi › GetTabbedTextExtentA

GetTabbedTextExtentA

関数

タブを展開した文字列の表示寸法を取得する(ANSI版)。

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

シグネチャ

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

DWORD GetTabbedTextExtentA(
    HDC hdc,
    LPCSTR lpString,
    INT chCount,
    INT nTabPositions,
    const INT* lpnTabStopPositions   // optional
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドルです。
lpString	LPCSTR	in	文字列へのポインターです。
chCount	INT	in	テキスト文字列の長さです。ANSI 関数ではバイト数 (BYTE count)、Unicode 関数ではワード数 (WORD count) になります。なお、ANSI 関数では、SBCS コードページの文字は 1 文字あたり 1 バイトですが、DBCS コードページのほとんどの文字は 2 バイトになります。Unicode 関数では、現在定義されているほとんどの Unicode 文字 (基本多言語面 (BMP) にあるもの) は 1 WORD ですが、Unicode サロゲートは 2 WORD になります。
nTabPositions	INT	in	lpnTabStopPositions パラメーターが指す配列内のタブストップ位置の数です。
lpnTabStopPositions	INT*	inoptional	タブストップ位置をデバイス単位で格納した配列へのポインターです。タブストップは昇順にソートされている必要があり、最も小さい x 値が配列の最初の要素になります。

戻り値の型: DWORD

公式ドキュメント

GetTabbedTextExtent 関数は、文字列の幅と高さを計算します。(ANSI)

戻り値

関数が成功した場合、戻り値は文字列の寸法を論理単位で表したものです。高さが上位ワード、幅が下位ワードに格納されます。

関数が失敗した場合、戻り値は 0 です。hDC が無効な場合、および nTabPositions が 0 未満の場合、GetTabbedTextExtent は失敗します。

解説(Remarks)

現在のクリッピング領域は、GetTabbedTextExtent 関数が返す幅と高さには影響しません。

一部のデバイスでは文字を規則的なセル配列に配置しない (つまり文字をカーニングする) ため、文字列内の各文字の幅の合計が、文字列全体の幅と一致しない場合があります。

nTabPositions パラメーターが 0 で、lpnTabStopPositions パラメーターが NULL の場合、タブは平均文字幅の 8 倍に展開されます。

nTabPositions が 1 の場合、タブストップは lpnTabStopPositions が指す配列の最初の値で指定された間隔で区切られます。

メモ

winuser.h ヘッダーは GetTabbedTextExtent をエイリアスとして定義しており、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)

各言語での呼び出し定義

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

DWORD GetTabbedTextExtentA(
    HDC hdc,
    LPCSTR lpString,
    INT chCount,
    INT nTabPositions,
    const INT* lpnTabStopPositions   // optional
);

[DllImport("USER32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint GetTabbedTextExtentA(
    IntPtr hdc,   // HDC
    [MarshalAs(UnmanagedType.LPStr)] string lpString,   // LPCSTR
    int chCount,   // INT
    int nTabPositions,   // INT
    IntPtr lpnTabStopPositions   // INT* optional
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetTabbedTextExtentA(
    hdc As IntPtr,   ' HDC
    <MarshalAs(UnmanagedType.LPStr)> lpString As String,   ' LPCSTR
    chCount As Integer,   ' INT
    nTabPositions As Integer,   ' INT
    lpnTabStopPositions As IntPtr   ' INT* optional
) As UInteger
End Function

' hdc : HDC
' lpString : LPCSTR
' chCount : INT
' nTabPositions : INT
' lpnTabStopPositions : INT* optional
Declare PtrSafe Function GetTabbedTextExtentA Lib "user32" ( _
    ByVal hdc As LongPtr, _
    ByVal lpString As String, _
    ByVal chCount As Long, _
    ByVal nTabPositions As Long, _
    ByVal lpnTabStopPositions As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetTabbedTextExtentA = ctypes.windll.user32.GetTabbedTextExtentA
GetTabbedTextExtentA.restype = wintypes.DWORD
GetTabbedTextExtentA.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.LPCSTR,  # lpString : LPCSTR
    ctypes.c_int,  # chCount : INT
    ctypes.c_int,  # nTabPositions : INT
    ctypes.POINTER(ctypes.c_int),  # lpnTabStopPositions : INT* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetTabbedTextExtentA = Fiddle::Function.new(
  lib['GetTabbedTextExtentA'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # lpString : LPCSTR
    Fiddle::TYPE_INT,  # chCount : INT
    Fiddle::TYPE_INT,  # nTabPositions : INT
    Fiddle::TYPE_VOIDP,  # lpnTabStopPositions : INT* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetTabbedTextExtentA(
        hdc: *mut core::ffi::c_void,  // HDC
        lpString: *const u8,  // LPCSTR
        chCount: i32,  // INT
        nTabPositions: i32,  // INT
        lpnTabStopPositions: *const i32  // INT* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi)]
public static extern uint GetTabbedTextExtentA(IntPtr hdc, [MarshalAs(UnmanagedType.LPStr)] string lpString, int chCount, int nTabPositions, IntPtr lpnTabStopPositions);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetTabbedTextExtentA' -Namespace Win32 -PassThru
# $api::GetTabbedTextExtentA(hdc, lpString, chCount, nTabPositions, lpnTabStopPositions)

#uselib "USER32.dll"
#func global GetTabbedTextExtentA "GetTabbedTextExtentA" sptr, sptr, sptr, sptr, sptr
; GetTabbedTextExtentA hdc, lpString, chCount, nTabPositions, varptr(lpnTabStopPositions)   ; 戻り値は stat
; hdc : HDC -> "sptr"
; lpString : LPCSTR -> "sptr"
; chCount : INT -> "sptr"
; nTabPositions : INT -> "sptr"
; lpnTabStopPositions : INT* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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