ホーム › Globalization › ScriptStringAnalyse

ScriptStringAnalyse

関数

文字列を解析し描画用の状態オブジェクトを生成する。

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

シグネチャ

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

HRESULT ScriptStringAnalyse(
    HDC hdc,
    const void* pString,
    INT cString,
    INT cGlyphs,
    INT iCharset,
    DWORD dwFlags,
    INT iReqWidth,
    SCRIPT_CONTROL* psControl,   // optional
    SCRIPT_STATE* psState,   // optional
    const INT* piDx,   // optional
    SCRIPT_TABDEF* pTabdef,   // optional
    const BYTE* pbInClass,
    void** pssa
);

パラメーター

名前型方向説明

hdc HDC in デバイスコンテキストへのハンドル。dwFlags に SSA_GLYPHS が設定されている場合、デバイスコンテキストハンドルは必須です。dwFlags に SSA_BREAK が設定されている場合、デバイスコンテキストハンドルは省略可能です。デバイスコンテキストハンドルが指定されている場合、この関数はデバイスコンテキスト内の現在のフォントを検査します。現在のフォントがシンボルフォントの場合、この関数は文字列を単一のニュートラルな SCRIPT_UNDEFINED 項目として扱います。

pString void* in 解析する文字列へのポインター。文字列には少なくとも 1 文字が含まれている必要があります。Unicode 文字列、または iCharset パラメーターで指定された Windows ANSI コードページの文字セットを使用する文字列を指定できます。

cString INT in 解析する文字列の長さ。長さは、ANSI 文字列では文字単位、Unicode 文字列ではワイド文字単位で測定されます。長さは少なくとも 1 でなければなりません。

cGlyphs INT in グリフバッファーのサイズ(WORD 値単位)。このサイズは必須です。推奨サイズは (1.5 * cString + 16) です。

iCharset

INT

文字セット記述子。入力文字列が ANSI 文字列の場合、この記述子には文字セット識別子が設定されます。文字列が Unicode 文字列の場合、この記述子には -1 が設定されます。

次の文字セット識別子が定義されています:

dwFlags

DWORD

必要な解析を示すフラグ。このパラメーターには、次の表に示す値のいずれかを指定できます。

値	意味
SSA_BREAK	区切りフラグ(文字および単語の区切り)を取得します。
SSA_CLIP	文字列を iReqWidth でクリップします。
SSA_DZWG	制御文字に対する表現用グリフを提供します。
SSA_FALLBACK	フォールバックフォントを使用します。
SSA_FIT	文字列を iReqWidth に合わせて両端揃えします。
SSA_GCP	GetCharacterPlacement の規約に従って、不足しているグリフと pwLogClust を取得します。
SSA_GLYPHS	グリフ、位置、および属性を生成します。
SSA_HIDEHOTKEY	表示文字列から最初の "&" を削除します。
SSA_HOTKEY	"&" を、その後続のコードポイントへの下線に置き換えます。
SSA_HOTKEYONLY	下線のみを表示します。生成されたビットパターンは、XOR マスクを使用して表示することで、テキストを乱すことなくホットキー下線の表示/非表示を切り替えることができます。
SSA_LINK	非複合テキストに東アジアフォントのリンクおよび関連付けを適用します。
SSA_METAFILE	項目をグリフではなく ExtTextOutW 呼び出しで書き込みます。
SSA_PASSWORD	単一文字を含む入力文字列を cString 回複製します。
SSA_RTL	基底埋め込みレベル 1 を使用します。
SSA_TAB	タブを展開します。

iReqWidth INT in フィッティングまたはクリッピングに必要な幅。

psControl SCRIPT_CONTROL* inoptional SCRIPT_CONTROL 構造体へのポインター。アプリケーションは、このパラメーターに NULL を設定することで、すべての SCRIPT_CONTROL メンバーを 0 に設定することを示すことができます。

psState SCRIPT_STATE* inoptional SCRIPT_STATE 構造体へのポインター。アプリケーションは、このパラメーターに NULL を設定することで、すべての SCRIPT_STATE メンバーを 0 に設定することを示すことができます。SCRIPT_STATE の uBidiLevel メンバーは無視されます。使用される値は、SSA_RTL フラグとデバイスコンテキストのレイアウトの組み合わせから導出されます。

piDx INT* inoptional 要求される論理 dx 配列へのポインター。

pTabdef SCRIPT_TABDEF* inoptional SCRIPT_TABDEF 構造体へのポインター。この値は、dwFlags に SSA_TAB が設定されている場合にのみ必要です。

pbInClass BYTE* in GetCharacterPlacement の文字分類を示す BYTE 値へのポインター。

pssa void** out この関数が SCRIPT_STRING_ANALYSIS 構造体を取得するバッファーへのポインター。この構造体は、関数の正常な戻り時に動的に割り当てられます。

戻り値の型: HRESULT

公式ドキュメント

プレーンテキスト文字列を解析します。

戻り値

成功した場合は S_OK を返します。成功しなかった場合、この関数は 0 以外の HRESULT 値を返します。

エラーの戻り値には次のものが含まれます:

E_INVALIDARG。無効なパラメーターが見つかりました。
USP_E_SCRIPT_NOT_IN_FONT。SSA_FALLBACK が指定されていないか、標準のフォールバックフォントが見つかりません。

また、この関数はシステムエラーを HRESULT 型に変換して返す場合もあります。たとえば、メモリ不足やデバイスコンテキストを使用した GDI 呼び出しによって返されるエラーなどです。

解説(Remarks)

この関数の使用は、プレーンテキスト文字列を処理する際の最初のステップです。そのような文字列は、フォント、スタイル、サイズ、色などをそれぞれ 1 つだけ持ちます。ScriptStringAnalyse は、項目解析、グリフ、送り幅などのための一時バッファーを割り当てます。そして、ScriptItemize、ScriptShape、ScriptPlace、および ScriptBreak を自動的に実行します。結果は、他のすべての ScriptString* 関数を通じて利用できます。

この関数の正常な戻り時には、pssa は動的に割り当てられた構造体を指します。アプリケーションはこの構造体を他の ScriptString* 関数に順次渡すことができます。アプリケーションは最終的に、ScriptStringFree を呼び出してこの構造体を解放する必要があります。

ScriptStringAnalyse の機能は他の関数を直接呼び出すことで実装できますが、この関数自体を使用することで、プレーンテキスト処理のためにアプリケーションに必要なコード量を大幅に削減できます。

重要 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 ScriptStringAnalyse(
    HDC hdc,
    const void* pString,
    INT cString,
    INT cGlyphs,
    INT iCharset,
    DWORD dwFlags,
    INT iReqWidth,
    SCRIPT_CONTROL* psControl,   // optional
    SCRIPT_STATE* psState,   // optional
    const INT* piDx,   // optional
    SCRIPT_TABDEF* pTabdef,   // optional
    const BYTE* pbInClass,
    void** pssa
);

[DllImport("USP10.dll", ExactSpelling = true)]
static extern int ScriptStringAnalyse(
    IntPtr hdc,   // HDC
    IntPtr pString,   // void*
    int cString,   // INT
    int cGlyphs,   // INT
    int iCharset,   // INT
    uint dwFlags,   // DWORD
    int iReqWidth,   // INT
    IntPtr psControl,   // SCRIPT_CONTROL* optional
    IntPtr psState,   // SCRIPT_STATE* optional
    IntPtr piDx,   // INT* optional
    IntPtr pTabdef,   // SCRIPT_TABDEF* optional
    IntPtr pbInClass,   // BYTE*
    IntPtr pssa   // void** out
);

<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptStringAnalyse(
    hdc As IntPtr,   ' HDC
    pString As IntPtr,   ' void*
    cString As Integer,   ' INT
    cGlyphs As Integer,   ' INT
    iCharset As Integer,   ' INT
    dwFlags As UInteger,   ' DWORD
    iReqWidth As Integer,   ' INT
    psControl As IntPtr,   ' SCRIPT_CONTROL* optional
    psState As IntPtr,   ' SCRIPT_STATE* optional
    piDx As IntPtr,   ' INT* optional
    pTabdef As IntPtr,   ' SCRIPT_TABDEF* optional
    pbInClass As IntPtr,   ' BYTE*
    pssa As IntPtr   ' void** out
) As Integer
End Function

' hdc : HDC
' pString : void*
' cString : INT
' cGlyphs : INT
' iCharset : INT
' dwFlags : DWORD
' iReqWidth : INT
' psControl : SCRIPT_CONTROL* optional
' psState : SCRIPT_STATE* optional
' piDx : INT* optional
' pTabdef : SCRIPT_TABDEF* optional
' pbInClass : BYTE*
' pssa : void** out
Declare PtrSafe Function ScriptStringAnalyse Lib "usp10" ( _
    ByVal hdc As LongPtr, _
    ByVal pString As LongPtr, _
    ByVal cString As Long, _
    ByVal cGlyphs As Long, _
    ByVal iCharset As Long, _
    ByVal dwFlags As Long, _
    ByVal iReqWidth As Long, _
    ByVal psControl As LongPtr, _
    ByVal psState As LongPtr, _
    ByVal piDx As LongPtr, _
    ByVal pTabdef As LongPtr, _
    ByVal pbInClass As LongPtr, _
    ByVal pssa As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScriptStringAnalyse = ctypes.windll.usp10.ScriptStringAnalyse
ScriptStringAnalyse.restype = ctypes.c_int
ScriptStringAnalyse.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.POINTER(None),  # pString : void*
    ctypes.c_int,  # cString : INT
    ctypes.c_int,  # cGlyphs : INT
    ctypes.c_int,  # iCharset : INT
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_int,  # iReqWidth : INT
    ctypes.c_void_p,  # psControl : SCRIPT_CONTROL* optional
    ctypes.c_void_p,  # psState : SCRIPT_STATE* optional
    ctypes.POINTER(ctypes.c_int),  # piDx : INT* optional
    ctypes.c_void_p,  # pTabdef : SCRIPT_TABDEF* optional
    ctypes.POINTER(ctypes.c_ubyte),  # pbInClass : BYTE*
    ctypes.c_void_p,  # pssa : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USP10.dll')
ScriptStringAnalyse = Fiddle::Function.new(
  lib['ScriptStringAnalyse'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # pString : void*
    Fiddle::TYPE_INT,  # cString : INT
    Fiddle::TYPE_INT,  # cGlyphs : INT
    Fiddle::TYPE_INT,  # iCharset : INT
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_INT,  # iReqWidth : INT
    Fiddle::TYPE_VOIDP,  # psControl : SCRIPT_CONTROL* optional
    Fiddle::TYPE_VOIDP,  # psState : SCRIPT_STATE* optional
    Fiddle::TYPE_VOIDP,  # piDx : INT* optional
    Fiddle::TYPE_VOIDP,  # pTabdef : SCRIPT_TABDEF* optional
    Fiddle::TYPE_VOIDP,  # pbInClass : BYTE*
    Fiddle::TYPE_VOIDP,  # pssa : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "usp10")]
extern "system" {
    fn ScriptStringAnalyse(
        hdc: *mut core::ffi::c_void,  // HDC
        pString: *const (),  // void*
        cString: i32,  // INT
        cGlyphs: i32,  // INT
        iCharset: i32,  // INT
        dwFlags: u32,  // DWORD
        iReqWidth: i32,  // INT
        psControl: *mut SCRIPT_CONTROL,  // SCRIPT_CONTROL* optional
        psState: *mut SCRIPT_STATE,  // SCRIPT_STATE* optional
        piDx: *const i32,  // INT* optional
        pTabdef: *mut SCRIPT_TABDEF,  // SCRIPT_TABDEF* optional
        pbInClass: *const u8,  // BYTE*
        pssa: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USP10.dll")]
public static extern int ScriptStringAnalyse(IntPtr hdc, IntPtr pString, int cString, int cGlyphs, int iCharset, uint dwFlags, int iReqWidth, IntPtr psControl, IntPtr psState, IntPtr piDx, IntPtr pTabdef, IntPtr pbInClass, IntPtr pssa);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USP10_ScriptStringAnalyse' -Namespace Win32 -PassThru
# $api::ScriptStringAnalyse(hdc, pString, cString, cGlyphs, iCharset, dwFlags, iReqWidth, psControl, psState, piDx, pTabdef, pbInClass, pssa)

#uselib "USP10.dll"
#func global ScriptStringAnalyse "ScriptStringAnalyse" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; ScriptStringAnalyse hdc, pString, cString, cGlyphs, iCharset, dwFlags, iReqWidth, varptr(psControl), varptr(psState), varptr(piDx), varptr(pTabdef), varptr(pbInClass), pssa   ; 戻り値は stat
; hdc : HDC -> "sptr"
; pString : void* -> "sptr"
; cString : INT -> "sptr"
; cGlyphs : INT -> "sptr"
; iCharset : INT -> "sptr"
; dwFlags : DWORD -> "sptr"
; iReqWidth : INT -> "sptr"
; psControl : SCRIPT_CONTROL* optional -> "sptr"
; psState : SCRIPT_STATE* optional -> "sptr"
; piDx : INT* optional -> "sptr"
; pTabdef : SCRIPT_TABDEF* optional -> "sptr"
; pbInClass : BYTE* -> "sptr"
; pssa : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USP10.dll"
#cfunc global ScriptStringAnalyse "ScriptStringAnalyse" sptr, sptr, int, int, int, int, int, var, var, var, var, var, sptr
; res = ScriptStringAnalyse(hdc, pString, cString, cGlyphs, iCharset, dwFlags, iReqWidth, psControl, psState, piDx, pTabdef, pbInClass, pssa)
; hdc : HDC -> "sptr"
; pString : void* -> "sptr"
; cString : INT -> "int"
; cGlyphs : INT -> "int"
; iCharset : INT -> "int"
; dwFlags : DWORD -> "int"
; iReqWidth : INT -> "int"
; psControl : SCRIPT_CONTROL* optional -> "var"
; psState : SCRIPT_STATE* optional -> "var"
; piDx : INT* optional -> "var"
; pTabdef : SCRIPT_TABDEF* optional -> "var"
; pbInClass : BYTE* -> "var"
; pssa : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USP10.dll"
#cfunc global ScriptStringAnalyse "ScriptStringAnalyse" sptr, sptr, int, int, int, int, int, sptr, sptr, sptr, sptr, sptr, sptr
; res = ScriptStringAnalyse(hdc, pString, cString, cGlyphs, iCharset, dwFlags, iReqWidth, varptr(psControl), varptr(psState), varptr(piDx), varptr(pTabdef), varptr(pbInClass), pssa)
; hdc : HDC -> "sptr"
; pString : void* -> "sptr"
; cString : INT -> "int"
; cGlyphs : INT -> "int"
; iCharset : INT -> "int"
; dwFlags : DWORD -> "int"
; iReqWidth : INT -> "int"
; psControl : SCRIPT_CONTROL* optional -> "sptr"
; psState : SCRIPT_STATE* optional -> "sptr"
; piDx : INT* optional -> "sptr"
; pTabdef : SCRIPT_TABDEF* optional -> "sptr"
; pbInClass : BYTE* -> "sptr"
; pssa : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。