ScriptStringOut

関数

解析済み文字列を選択範囲付きでデバイスに描画する。

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

シグネチャ

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

HRESULT ScriptStringOut(
    void* ssa,
    INT iX,
    INT iY,
    ETO_OPTIONS uOptions,
    const RECT* prc,   // optional
    INT iMinSel,
    INT iMaxSel,
    BOOL fDisabled
);

パラメーター

名前

型

方向

説明

ssa

void*

文字列に対応する SCRIPT_STRING_ANALYSIS 構造体です。

INT

文字列の位置を決めるために使用する基準点の x 座標です。

INT

文字列の位置を決めるために使用する基準点の y 座標です。

uOptions

ETO_OPTIONS

アプリケーション定義の矩形の使用方法を指定するオプションです。このパラメーターには 0 または次のいずれかの値を設定できます。これらの値はビット OR で組み合わせることができます。

値	意味
ETO_CLIPPED	テキストを矩形にクリップします。
ETO_OPAQUE	現在の背景色を使用して矩形を塗りつぶします。

prc

RECT*

inoptional

使用する矩形を定義する RECT 構造体へのポインターです。uOptions に ETO_OPAQUE が設定され、prc に NULL が指定された場合、この関数は成功して S_OK を返します。ただし、アプリケーションが uOptions に ETO_CLIPPING を設定し、prc に NULL を指定した場合は、この関数は E_INVALIDARG を返します。オプションが不要であることを示すために、アプリケーションはこのパラメーターに NULL を設定できます。

iMinSel

INT

文字列内の開始位置を指定する 0 から始まるインデックスです。選択範囲がない場合、アプリケーションは iMinSel >= iMaxSel となるように設定する必要があります。

iMaxSel

INT

文字列内の終了位置を指定する 0 から始まるインデックスです。

fDisabled

BOOL

オペレーティングシステムが、選択されたすべての文字の背後の背景色を COLOR_HIGHLIGHT に設定して無効テキストのハイライト表示を適用する場合は TRUE を指定します。オペレーティングシステムが、選択された各文字について背景色を COLOR_HIGHLIGHT、テキスト色を COLOR_HIGHLIGHTTEXT に設定して有効テキストのハイライト表示を適用する場合、アプリケーションはこのパラメーターに FALSE を設定できます。

戻り値の型: HRESULT

公式ドキュメント

先行する ScriptStringAnalyse の呼び出しによって生成された文字列を表示し、必要に応じてハイライト表示を追加します。

戻り値

成功した場合は S_OK を返します。成功しなかった場合、この関数は 0 以外の HRESULT 値を返します。アプリケーションは SUCCEEDED マクロおよび FAILED マクロで戻り値をテストできません。

解説(Remarks)

この関数を使用するには、アプリケーションは ScriptStringAnalyse への最初の呼び出しで SSA_GLYPHS を指定する必要があります。

選択されたテキストは正しく描画できないため、アプリケーションは ScriptStringOut を使用する際に SetTextAlign を TA_UPDATECP とともに使用しないでください。このフラグを使用する必要がある場合は、問題を回避するために必要に応じてフラグを解除および再設定できます。

重要 Windows 8 以降: Windows 7 上で実行できる状態を維持するため、Uniscribe を使用するモジュールは、ライブラリ一覧で gdi32.lib より前に Usp10.lib を指定する必要があります。

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

各言語での呼び出し定義

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

HRESULT ScriptStringOut(
    void* ssa,
    INT iX,
    INT iY,
    ETO_OPTIONS uOptions,
    const RECT* prc,   // optional
    INT iMinSel,
    INT iMaxSel,
    BOOL fDisabled
);

[DllImport("USP10.dll", ExactSpelling = true)]
static extern int ScriptStringOut(
    IntPtr ssa,   // void*
    int iX,   // INT
    int iY,   // INT
    uint uOptions,   // ETO_OPTIONS
    IntPtr prc,   // RECT* optional
    int iMinSel,   // INT
    int iMaxSel,   // INT
    bool fDisabled   // BOOL
);

<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptStringOut(
    ssa As IntPtr,   ' void*
    iX As Integer,   ' INT
    iY As Integer,   ' INT
    uOptions As UInteger,   ' ETO_OPTIONS
    prc As IntPtr,   ' RECT* optional
    iMinSel As Integer,   ' INT
    iMaxSel As Integer,   ' INT
    fDisabled As Boolean   ' BOOL
) As Integer
End Function

' ssa : void*
' iX : INT
' iY : INT
' uOptions : ETO_OPTIONS
' prc : RECT* optional
' iMinSel : INT
' iMaxSel : INT
' fDisabled : BOOL
Declare PtrSafe Function ScriptStringOut Lib "usp10" ( _
    ByVal ssa As LongPtr, _
    ByVal iX As Long, _
    ByVal iY As Long, _
    ByVal uOptions As Long, _
    ByVal prc As LongPtr, _
    ByVal iMinSel As Long, _
    ByVal iMaxSel As Long, _
    ByVal fDisabled As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScriptStringOut = ctypes.windll.usp10.ScriptStringOut
ScriptStringOut.restype = ctypes.c_int
ScriptStringOut.argtypes = [
    ctypes.POINTER(None),  # ssa : void*
    ctypes.c_int,  # iX : INT
    ctypes.c_int,  # iY : INT
    wintypes.DWORD,  # uOptions : ETO_OPTIONS
    ctypes.c_void_p,  # prc : RECT* optional
    ctypes.c_int,  # iMinSel : INT
    ctypes.c_int,  # iMaxSel : INT
    wintypes.BOOL,  # fDisabled : BOOL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USP10.dll')
ScriptStringOut = Fiddle::Function.new(
  lib['ScriptStringOut'],
  [
    Fiddle::TYPE_VOIDP,  # ssa : void*
    Fiddle::TYPE_INT,  # iX : INT
    Fiddle::TYPE_INT,  # iY : INT
    -Fiddle::TYPE_INT,  # uOptions : ETO_OPTIONS
    Fiddle::TYPE_VOIDP,  # prc : RECT* optional
    Fiddle::TYPE_INT,  # iMinSel : INT
    Fiddle::TYPE_INT,  # iMaxSel : INT
    Fiddle::TYPE_INT,  # fDisabled : BOOL
  ],
  Fiddle::TYPE_INT)

#[link(name = "usp10")]
extern "system" {
    fn ScriptStringOut(
        ssa: *mut (),  // void*
        iX: i32,  // INT
        iY: i32,  // INT
        uOptions: u32,  // ETO_OPTIONS
        prc: *const RECT,  // RECT* optional
        iMinSel: i32,  // INT
        iMaxSel: i32,  // INT
        fDisabled: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USP10.dll")]
public static extern int ScriptStringOut(IntPtr ssa, int iX, int iY, uint uOptions, IntPtr prc, int iMinSel, int iMaxSel, bool fDisabled);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USP10_ScriptStringOut' -Namespace Win32 -PassThru
# $api::ScriptStringOut(ssa, iX, iY, uOptions, prc, iMinSel, iMaxSel, fDisabled)

#uselib "USP10.dll"
#func global ScriptStringOut "ScriptStringOut" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; ScriptStringOut ssa, iX, iY, uOptions, varptr(prc), iMinSel, iMaxSel, fDisabled   ; 戻り値は stat
; ssa : void* -> "sptr"
; iX : INT -> "sptr"
; iY : INT -> "sptr"
; uOptions : ETO_OPTIONS -> "sptr"
; prc : RECT* optional -> "sptr"
; iMinSel : INT -> "sptr"
; iMaxSel : INT -> "sptr"
; fDisabled : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USP10.dll"
#cfunc global ScriptStringOut "ScriptStringOut" sptr, int, int, int, var, int, int, int
; res = ScriptStringOut(ssa, iX, iY, uOptions, prc, iMinSel, iMaxSel, fDisabled)
; ssa : void* -> "sptr"
; iX : INT -> "int"
; iY : INT -> "int"
; uOptions : ETO_OPTIONS -> "int"
; prc : RECT* optional -> "var"
; iMinSel : INT -> "int"
; iMaxSel : INT -> "int"
; fDisabled : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USP10.dll"
#cfunc global ScriptStringOut "ScriptStringOut" sptr, int, int, int, sptr, int, int, int
; res = ScriptStringOut(ssa, iX, iY, uOptions, varptr(prc), iMinSel, iMaxSel, fDisabled)
; ssa : void* -> "sptr"
; iX : INT -> "int"
; iY : INT -> "int"
; uOptions : ETO_OPTIONS -> "int"
; prc : RECT* optional -> "sptr"
; iMinSel : INT -> "int"
; iMaxSel : INT -> "int"
; fDisabled : BOOL -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。