ホーム › Graphics.Gdi › GetTabbedTextExtentW

GetTabbedTextExtentW

関数

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

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

シグネチャ

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

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

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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

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

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetTabbedTextExtent を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーの原因となる場合があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

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

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

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

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

' hdc : HDC
' lpString : LPCWSTR
' chCount : INT
' nTabPositions : INT
' lpnTabStopPositions : INT* optional
Declare PtrSafe Function GetTabbedTextExtentW Lib "user32" ( _
    ByVal hdc As LongPtr, _
    ByVal lpString As LongPtr, _
    ByVal chCount As Long, _
    ByVal nTabPositions As Long, _
    ByVal lpnTabStopPositions 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

GetTabbedTextExtentW = ctypes.windll.user32.GetTabbedTextExtentW
GetTabbedTextExtentW.restype = wintypes.DWORD
GetTabbedTextExtentW.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.LPCWSTR,  # lpString : LPCWSTR
    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')
GetTabbedTextExtentW = Fiddle::Function.new(
  lib['GetTabbedTextExtentW'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # lpString : LPCWSTR
    Fiddle::TYPE_INT,  # chCount : INT
    Fiddle::TYPE_INT,  # nTabPositions : INT
    Fiddle::TYPE_VOIDP,  # lpnTabStopPositions : INT* optional
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

出力引数:

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