ScriptBreak

関数

文字列の論理的な改行・分割属性を取得する。

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

シグネチャ

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

HRESULT ScriptBreak(
    LPCWSTR pwcChars,
    INT cChars,
    const SCRIPT_ANALYSIS* psa,
    SCRIPT_LOGATTR* psla
);

パラメーター

名前	型	方向	説明
pwcChars	LPCWSTR	in	処理する Unicode 文字へのポインター。
cChars	INT	in	処理する Unicode 文字の数。
psa	SCRIPT_ANALYSIS*	in	以前の ScriptItemize の呼び出しで取得した SCRIPT_ANALYSIS 構造体へのポインター。
psla	SCRIPT_LOGATTR*	out	この関数が文字属性を SCRIPT_LOGATTR 構造体として取得するバッファーへのポインター。

戻り値の型: HRESULT

公式ドキュメント

改行位置を決定するための情報を取得します。

戻り値

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

解説(Remarks)

この関数が通常呼び出される文脈については、Displaying Text with Uniscribe を参照してください。

この関数はデバイスコンテキストを必要とせず、グリフシェーピングも行いません。

この関数は、SCRIPT_LOGATTR 構造体の配列内の項目について、カーソル移動位置と書式上の改行位置を取得します。1 つの単語内に複数の書式が混在する場合に正しく処理するには、ScriptBreak の呼び出しでは、より細かい書式ランではなく、ScriptItemize で取得した項目全体を渡す必要があります。

SCRIPT_LOGATTR 構造体は、有効なキャレット位置と改行位置を示します。fCharStop メンバーは、クラスター内部への移動が慣例的に制限されているスクリプトについて、クラスター境界を示すフラグを指定します。同じ境界は、ScriptShape で取得した論理クラスター情報を調べることでも推測できます。ただし、ScriptBreak は実装上かなり高速であり、デバイスコンテキストの準備を必要としません。

SCRIPT_LOGATTR の fWordStop、fSoftBreak、fWhiteSpace の各メンバーで指定されるフラグは、ScriptBreak を通じてのみ取得できます。

無効なシーケンスを識別するほとんどのシェーピングエンジンは、ScriptBreak において SCRIPT_LOGATTR の fInvalid メンバーで示されるフラグを設定します。SCRIPT_PROPERTIES の fInvalidLogAttr メンバーは、該当するスクリプトを識別します。

重要 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 ScriptBreak(
    LPCWSTR pwcChars,
    INT cChars,
    const SCRIPT_ANALYSIS* psa,
    SCRIPT_LOGATTR* psla
);

[DllImport("USP10.dll", ExactSpelling = true)]
static extern int ScriptBreak(
    [MarshalAs(UnmanagedType.LPWStr)] string pwcChars,   // LPCWSTR
    int cChars,   // INT
    IntPtr psa,   // SCRIPT_ANALYSIS*
    IntPtr psla   // SCRIPT_LOGATTR* out
);

<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptBreak(
    <MarshalAs(UnmanagedType.LPWStr)> pwcChars As String,   ' LPCWSTR
    cChars As Integer,   ' INT
    psa As IntPtr,   ' SCRIPT_ANALYSIS*
    psla As IntPtr   ' SCRIPT_LOGATTR* out
) As Integer
End Function

' pwcChars : LPCWSTR
' cChars : INT
' psa : SCRIPT_ANALYSIS*
' psla : SCRIPT_LOGATTR* out
Declare PtrSafe Function ScriptBreak Lib "usp10" ( _
    ByVal pwcChars As LongPtr, _
    ByVal cChars As Long, _
    ByVal psa As LongPtr, _
    ByVal psla As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScriptBreak = ctypes.windll.usp10.ScriptBreak
ScriptBreak.restype = ctypes.c_int
ScriptBreak.argtypes = [
    wintypes.LPCWSTR,  # pwcChars : LPCWSTR
    ctypes.c_int,  # cChars : INT
    ctypes.c_void_p,  # psa : SCRIPT_ANALYSIS*
    ctypes.c_void_p,  # psla : SCRIPT_LOGATTR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USP10.dll')
ScriptBreak = Fiddle::Function.new(
  lib['ScriptBreak'],
  [
    Fiddle::TYPE_VOIDP,  # pwcChars : LPCWSTR
    Fiddle::TYPE_INT,  # cChars : INT
    Fiddle::TYPE_VOIDP,  # psa : SCRIPT_ANALYSIS*
    Fiddle::TYPE_VOIDP,  # psla : SCRIPT_LOGATTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "usp10")]
extern "system" {
    fn ScriptBreak(
        pwcChars: *const u16,  // LPCWSTR
        cChars: i32,  // INT
        psa: *const SCRIPT_ANALYSIS,  // SCRIPT_ANALYSIS*
        psla: *mut SCRIPT_LOGATTR  // SCRIPT_LOGATTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USP10.dll")]
public static extern int ScriptBreak([MarshalAs(UnmanagedType.LPWStr)] string pwcChars, int cChars, IntPtr psa, IntPtr psla);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USP10_ScriptBreak' -Namespace Win32 -PassThru
# $api::ScriptBreak(pwcChars, cChars, psa, psla)

#uselib "USP10.dll"
#func global ScriptBreak "ScriptBreak" sptr, sptr, sptr, sptr
; ScriptBreak pwcChars, cChars, varptr(psa), varptr(psla)   ; 戻り値は stat
; pwcChars : LPCWSTR -> "sptr"
; cChars : INT -> "sptr"
; psa : SCRIPT_ANALYSIS* -> "sptr"
; psla : SCRIPT_LOGATTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USP10.dll"
#cfunc global ScriptBreak "ScriptBreak" wstr, int, var, var
; res = ScriptBreak(pwcChars, cChars, psa, psla)
; pwcChars : LPCWSTR -> "wstr"
; cChars : INT -> "int"
; psa : SCRIPT_ANALYSIS* -> "var"
; psla : SCRIPT_LOGATTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USP10.dll"
#cfunc global ScriptBreak "ScriptBreak" wstr, int, sptr, sptr
; res = ScriptBreak(pwcChars, cChars, varptr(psa), varptr(psla))
; pwcChars : LPCWSTR -> "wstr"
; cChars : INT -> "int"
; psa : SCRIPT_ANALYSIS* -> "sptr"
; psla : SCRIPT_LOGATTR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。