PolyTextOutA

関数

複数の文字列を一括して描画する(ANSI版)。

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

シグネチャ

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

BOOL PolyTextOutA(
    HDC hdc,
    const POLYTEXTA* ppt,
    INT nstrings
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。
ppt	POLYTEXTA*	in	描画する文字列を記述した POLYTEXT 構造体の配列へのポインター。配列には、描画する文字列ごとに 1 つの構造体が含まれます。
nstrings	INT	in	pptxt 配列内の POLYTEXT 構造体の数。

戻り値の型: BOOL

公式ドキュメント

PolyTextOut 関数は、指定したデバイスコンテキストで現在選択されているフォントとテキスト色を使用して、複数の文字列を描画します。(ANSI)

戻り値

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

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

解説(Remarks)

各 POLYTEXT 構造体には、Windows が対応するテキスト文字列の配置に使用する基準点の座標が含まれます。アプリケーションは、SetTextAlign 関数を呼び出すことで、基準点の使用方法を指定できます。アプリケーションは、GetTextAlign 関数を呼び出すことで、指定したデバイスコンテキストの現在のテキスト配置設定を取得できます。

単一のテキスト文字列を描画するには、アプリケーションは ExtTextOut 関数を呼び出す必要があります。

PolyTextOut は、国際的なスクリプトのサポートを自動的に処理しません。国際的なスクリプトのサポートを得るには、代わりに ExtTextOut を使用してください。ExtTextOut は必要に応じて Uniscribe を使用し、その結果としてフォントフォールバックが行われます。さらに、ExtTextOut はカーネルモードに移行する前に呼び出しを内部でバッチ処理するため、PolyTextOut と ExtTextOut のどちらを使用するか検討する際のパフォーマンス上の懸念の一部を緩和します。

ヒント

さまざまな言語の表示を処理できるため、最新の開発では PolyTextOut よりも ExtTextOut を強く推奨します。

メモ

wingdi.h ヘッダーは PolyTextOut を、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)

各言語での呼び出し定義

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

BOOL PolyTextOutA(
    HDC hdc,
    const POLYTEXTA* ppt,
    INT nstrings
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool PolyTextOutA(
    IntPtr hdc,   // HDC
    IntPtr ppt,   // POLYTEXTA*
    int nstrings   // INT
);

<DllImport("GDI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PolyTextOutA(
    hdc As IntPtr,   ' HDC
    ppt As IntPtr,   ' POLYTEXTA*
    nstrings As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' ppt : POLYTEXTA*
' nstrings : INT
Declare PtrSafe Function PolyTextOutA Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal ppt As LongPtr, _
    ByVal nstrings As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PolyTextOutA = ctypes.windll.gdi32.PolyTextOutA
PolyTextOutA.restype = wintypes.BOOL
PolyTextOutA.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_void_p,  # ppt : POLYTEXTA*
    ctypes.c_int,  # nstrings : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
PolyTextOutA = Fiddle::Function.new(
  lib['PolyTextOutA'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # ppt : POLYTEXTA*
    Fiddle::TYPE_INT,  # nstrings : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn PolyTextOutA(
        hdc: *mut core::ffi::c_void,  // HDC
        ppt: *const POLYTEXTA,  // POLYTEXTA*
        nstrings: i32  // INT
    ) -> 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 PolyTextOutA(IntPtr hdc, IntPtr ppt, int nstrings);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_PolyTextOutA' -Namespace Win32 -PassThru
# $api::PolyTextOutA(hdc, ppt, nstrings)

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

出力引数:

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