TabbedTextOutA

関数

タブ位置を展開して文字列を描画する(ANSI版)。

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

シグネチャ

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

INT TabbedTextOutA(
    HDC hdc,
    INT x,
    INT y,
    LPCSTR lpString,
    INT chCount,
    INT nTabPositions,
    const INT* lpnTabStopPositions,   // optional
    INT nTabOrigin
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。
x	INT	in	文字列の開始点の x 座標(論理単位)。
y	INT	in	文字列の開始点の y 座標(論理単位)。
lpString	LPCSTR	in	描画する文字列へのポインター。nCount が文字列の長さを指定するため、文字列はゼロ終端されている必要はありません。
chCount	INT	in	lpString が指す文字列の長さ。
nTabPositions	INT	in	タブストップ位置の配列内の値の数。
lpnTabStopPositions	INT*	inoptional	タブストップ位置を含む配列へのポインター(論理単位)。タブストップは昇順にソートされている必要があり、最小の x 値が配列の最初の項目になります。
nTabOrigin	INT	in	タブの展開を開始する位置の x 座標(論理単位)。

戻り値の型: INT

公式ドキュメント

TabbedTextOut 関数は、指定した位置に文字列を書き込み、タブをタブストップ位置の配列で指定された値に展開します。テキストは、現在選択されているフォント、背景色、およびテキスト色で書き込まれます。(ANSI)

戻り値

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

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

解説(Remarks)

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

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

lpnTabStopPositions 配列に複数の値が含まれている場合、nTabPositions で指定された数まで、配列内の各値に対してタブストップが設定されます。

nTabOrigin パラメーターを使用すると、アプリケーションは 1 行に対して TabbedTextOut 関数を複数回呼び出すことができます。アプリケーションが nTabOrigin を毎回同じ値に設定して TabbedTextOut を複数回呼び出すと、この関数は nTabOrigin で指定された位置を基準にしてすべてのタブを展開します。

既定では、現在位置は TabbedTextOut 関数によって使用も更新もされません。アプリケーションが TabbedTextOut の呼び出し時に現在位置を更新する必要がある場合は、wFlags パラメーターを TA_UPDATECP に設定して SetTextAlign 関数を呼び出すことができます。このフラグが設定されている場合、システムは以降の TabbedTextOut 関数の呼び出しで X および Y パラメーターを無視し、代わりに現在位置を使用します。

注意 Windows Vista 以降では、TabbedTextOut はテキストを描画する際にテキストの配置を無視します。

メモ

winuser.h ヘッダーは TabbedTextOut を、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>

INT TabbedTextOutA(
    HDC hdc,
    INT x,
    INT y,
    LPCSTR lpString,
    INT chCount,
    INT nTabPositions,
    const INT* lpnTabStopPositions,   // optional
    INT nTabOrigin
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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