Win32 API 日本語リファレンス
ホームGlobalization › ScriptLayout

ScriptLayout

関数
双方向レベルから論理順と視覚順の対応を生成する。
DLLUSP10.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT ScriptLayout(
    INT cRuns,
    const BYTE* pbLevel,
    INT* piVisualToLogical,   // optional
    INT* piLogicalToVisual   // optional
);

パラメーター

名前方向説明
cRunsINTin処理するランの数。
pbLevelBYTE*incRuns で指定される長さの配列へのポインター。ランの埋め込みレベルが格納されます。行内のすべてのランの埋め込みレベルを、論理順に並べて含める必要があります。詳細については「解説」セクションを参照してください。
piVisualToLogicalINT*outoptionalcRuns で指定される長さの配列へのポインター。この関数は、視覚順に並べ替えたランの埋め込みレベルをこの配列に格納します。最初の配列要素は最も左に表示するランを表し、後続の要素は左から右へ進む順に表示する必要があります。出力がない場合、この関数はこのパラメーターを NULL に設定します。
piLogicalToVisualINT*outoptionalcRuns で指定される長さの配列へのポインター。この関数は、ランの視覚順の位置をこの配列に格納します。最初の配列要素は、最初の論理ランを表示すべき相対的な視覚位置であり、最も左の表示位置は 0 です。出力がない場合、この関数はこのパラメーターを NULL に設定します。

戻り値の型: HRESULT

公式ドキュメント

ラン(run)の埋め込みレベルの配列を、視覚順から論理順への対応、または論理順から視覚順への対応(あるいはその両方)のマップに変換します。

戻り値

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

解説(Remarks)

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

この関数は、1 行のテキストに関するデータのみを処理します。

ランの埋め込みレベルは、Unicode 双方向アルゴリズムで定義されています。これらはランの方向、そのランが埋め込まれているランの方向、および段落の方向を記述します。この関数の呼び出しに必要な入力はこれ以外にありません。詳細については Unicode を参照してください。

次の表に、定義済みの埋め込みレベルを示します。アプリケーションは必要に応じてレベルを追加できます。

レベル 意味
0 左から右の段落内にある、左から右のラン。
1 左から右の段落内の左から右のランに埋め込まれた、右から左のラン。あるいは、右から左の段落内にあり、他のランに埋め込まれていない右から左のラン。
2 タイプ 1 の右から左のランに埋め込まれた、左から右のラン。
3 タイプ 2 の左から右のランに埋め込まれた、右から左のラン。

「論理位置」とは、他のランとの相対的なランの配置を指します。これはバッキングストア内の位置であり、ユーザーがテキストを声に出して読む順序に対応します。ランの「視覚位置」とは、ランが取り得る方向を考慮したうえで、その行上にランが視覚的に表示される方法を指します。

アプリケーションは、piLogicalToVisual または piVisualToLogical のいずれか一方、あるいは両方を設定してこの関数を呼び出すことができます。

重要 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 ScriptLayout(
    INT cRuns,
    const BYTE* pbLevel,
    INT* piVisualToLogical,   // optional
    INT* piLogicalToVisual   // optional
);
[DllImport("USP10.dll", ExactSpelling = true)]
static extern int ScriptLayout(
    int cRuns,   // INT
    IntPtr pbLevel,   // BYTE*
    IntPtr piVisualToLogical,   // INT* optional, out
    IntPtr piLogicalToVisual   // INT* optional, out
);
<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptLayout(
    cRuns As Integer,   ' INT
    pbLevel As IntPtr,   ' BYTE*
    piVisualToLogical As IntPtr,   ' INT* optional, out
    piLogicalToVisual As IntPtr   ' INT* optional, out
) As Integer
End Function
' cRuns : INT
' pbLevel : BYTE*
' piVisualToLogical : INT* optional, out
' piLogicalToVisual : INT* optional, out
Declare PtrSafe Function ScriptLayout Lib "usp10" ( _
    ByVal cRuns As Long, _
    ByVal pbLevel As LongPtr, _
    ByVal piVisualToLogical As LongPtr, _
    ByVal piLogicalToVisual As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ScriptLayout = ctypes.windll.usp10.ScriptLayout
ScriptLayout.restype = ctypes.c_int
ScriptLayout.argtypes = [
    ctypes.c_int,  # cRuns : INT
    ctypes.POINTER(ctypes.c_ubyte),  # pbLevel : BYTE*
    ctypes.POINTER(ctypes.c_int),  # piVisualToLogical : INT* optional, out
    ctypes.POINTER(ctypes.c_int),  # piLogicalToVisual : INT* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USP10.dll')
ScriptLayout = Fiddle::Function.new(
  lib['ScriptLayout'],
  [
    Fiddle::TYPE_INT,  # cRuns : INT
    Fiddle::TYPE_VOIDP,  # pbLevel : BYTE*
    Fiddle::TYPE_VOIDP,  # piVisualToLogical : INT* optional, out
    Fiddle::TYPE_VOIDP,  # piLogicalToVisual : INT* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "usp10")]
extern "system" {
    fn ScriptLayout(
        cRuns: i32,  // INT
        pbLevel: *const u8,  // BYTE*
        piVisualToLogical: *mut i32,  // INT* optional, out
        piLogicalToVisual: *mut i32  // INT* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USP10.dll")]
public static extern int ScriptLayout(int cRuns, IntPtr pbLevel, IntPtr piVisualToLogical, IntPtr piLogicalToVisual);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USP10_ScriptLayout' -Namespace Win32 -PassThru
# $api::ScriptLayout(cRuns, pbLevel, piVisualToLogical, piLogicalToVisual)
#uselib "USP10.dll"
#func global ScriptLayout "ScriptLayout" sptr, sptr, sptr, sptr
; ScriptLayout cRuns, varptr(pbLevel), varptr(piVisualToLogical), varptr(piLogicalToVisual)   ; 戻り値は stat
; cRuns : INT -> "sptr"
; pbLevel : BYTE* -> "sptr"
; piVisualToLogical : INT* optional, out -> "sptr"
; piLogicalToVisual : INT* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USP10.dll"
#cfunc global ScriptLayout "ScriptLayout" int, var, var, var
; res = ScriptLayout(cRuns, pbLevel, piVisualToLogical, piLogicalToVisual)
; cRuns : INT -> "int"
; pbLevel : BYTE* -> "var"
; piVisualToLogical : INT* optional, out -> "var"
; piLogicalToVisual : INT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT ScriptLayout(INT cRuns, BYTE* pbLevel, INT* piVisualToLogical, INT* piLogicalToVisual)
#uselib "USP10.dll"
#cfunc global ScriptLayout "ScriptLayout" int, var, var, var
; res = ScriptLayout(cRuns, pbLevel, piVisualToLogical, piLogicalToVisual)
; cRuns : INT -> "int"
; pbLevel : BYTE* -> "var"
; piVisualToLogical : INT* optional, out -> "var"
; piLogicalToVisual : INT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	usp10 = windows.NewLazySystemDLL("USP10.dll")
	procScriptLayout = usp10.NewProc("ScriptLayout")
)

// cRuns (INT), pbLevel (BYTE*), piVisualToLogical (INT* optional, out), piLogicalToVisual (INT* optional, out)
r1, _, err := procScriptLayout.Call(
	uintptr(cRuns),
	uintptr(pbLevel),
	uintptr(piVisualToLogical),
	uintptr(piLogicalToVisual),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function ScriptLayout(
  cRuns: Integer;   // INT
  pbLevel: Pointer;   // BYTE*
  piVisualToLogical: Pointer;   // INT* optional, out
  piLogicalToVisual: Pointer   // INT* optional, out
): Integer; stdcall;
  external 'USP10.dll' name 'ScriptLayout';
result := DllCall("USP10\ScriptLayout"
    , "Int", cRuns   ; INT
    , "Ptr", pbLevel   ; BYTE*
    , "Ptr", piVisualToLogical   ; INT* optional, out
    , "Ptr", piLogicalToVisual   ; INT* optional, out
    , "Int")   ; return: HRESULT
●ScriptLayout(cRuns, pbLevel, piVisualToLogical, piLogicalToVisual) = DLL("USP10.dll", "int ScriptLayout(int, void*, void*, void*)")
# 呼び出し: ScriptLayout(cRuns, pbLevel, piVisualToLogical, piLogicalToVisual)
# cRuns : INT -> "int"
# pbLevel : BYTE* -> "void*"
# piVisualToLogical : INT* optional, out -> "void*"
# piLogicalToVisual : INT* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "usp10" fn ScriptLayout(
    cRuns: i32, // INT
    pbLevel: [*c]u8, // BYTE*
    piVisualToLogical: [*c]i32, // INT* optional, out
    piLogicalToVisual: [*c]i32 // INT* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc ScriptLayout(
    cRuns: int32,  # INT
    pbLevel: ptr uint8,  # BYTE*
    piVisualToLogical: ptr int32,  # INT* optional, out
    piLogicalToVisual: ptr int32  # INT* optional, out
): int32 {.importc: "ScriptLayout", stdcall, dynlib: "USP10.dll".}
pragma(lib, "usp10");
extern(Windows)
int ScriptLayout(
    int cRuns,   // INT
    ubyte* pbLevel,   // BYTE*
    int* piVisualToLogical,   // INT* optional, out
    int* piLogicalToVisual   // INT* optional, out
);
ccall((:ScriptLayout, "USP10.dll"), stdcall, Int32,
      (Int32, Ptr{UInt8}, Ptr{Int32}, Ptr{Int32}),
      cRuns, pbLevel, piVisualToLogical, piLogicalToVisual)
# cRuns : INT -> Int32
# pbLevel : BYTE* -> Ptr{UInt8}
# piVisualToLogical : INT* optional, out -> Ptr{Int32}
# piLogicalToVisual : INT* optional, out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ScriptLayout(
    int32_t cRuns,
    uint8_t* pbLevel,
    int32_t* piVisualToLogical,
    int32_t* piLogicalToVisual);
]]
local usp10 = ffi.load("usp10")
-- usp10.ScriptLayout(cRuns, pbLevel, piVisualToLogical, piLogicalToVisual)
-- cRuns : INT
-- pbLevel : BYTE*
-- piVisualToLogical : INT* optional, out
-- piLogicalToVisual : INT* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USP10.dll');
const ScriptLayout = lib.func('__stdcall', 'ScriptLayout', 'int32_t', ['int32_t', 'uint8_t *', 'int32_t *', 'int32_t *']);
// ScriptLayout(cRuns, pbLevel, piVisualToLogical, piLogicalToVisual)
// cRuns : INT -> 'int32_t'
// pbLevel : BYTE* -> 'uint8_t *'
// piVisualToLogical : INT* optional, out -> 'int32_t *'
// piLogicalToVisual : INT* optional, out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USP10.dll", {
  ScriptLayout: { parameters: ["i32", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.ScriptLayout(cRuns, pbLevel, piVisualToLogical, piLogicalToVisual)
// cRuns : INT -> "i32"
// pbLevel : BYTE* -> "pointer"
// piVisualToLogical : INT* optional, out -> "pointer"
// piLogicalToVisual : INT* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ScriptLayout(
    int32_t cRuns,
    uint8_t* pbLevel,
    int32_t* piVisualToLogical,
    int32_t* piLogicalToVisual);
C, "USP10.dll");
// $ffi->ScriptLayout(cRuns, pbLevel, piVisualToLogical, piLogicalToVisual);
// cRuns : INT
// pbLevel : BYTE*
// piVisualToLogical : INT* optional, out
// piLogicalToVisual : INT* optional, out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Usp10 extends StdCallLibrary {
    Usp10 INSTANCE = Native.load("usp10", Usp10.class);
    int ScriptLayout(
        int cRuns,   // INT
        byte[] pbLevel,   // BYTE*
        IntByReference piVisualToLogical,   // INT* optional, out
        IntByReference piLogicalToVisual   // INT* optional, out
    );
}
@[Link("usp10")]
lib LibUSP10
  fun ScriptLayout = ScriptLayout(
    cRuns : Int32,   # INT
    pbLevel : UInt8*,   # BYTE*
    piVisualToLogical : Int32*,   # INT* optional, out
    piLogicalToVisual : Int32*   # INT* optional, out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ScriptLayoutNative = Int32 Function(Int32, Pointer<Uint8>, Pointer<Int32>, Pointer<Int32>);
typedef ScriptLayoutDart = int Function(int, Pointer<Uint8>, Pointer<Int32>, Pointer<Int32>);
final ScriptLayout = DynamicLibrary.open('USP10.dll')
    .lookupFunction<ScriptLayoutNative, ScriptLayoutDart>('ScriptLayout');
// cRuns : INT -> Int32
// pbLevel : BYTE* -> Pointer<Uint8>
// piVisualToLogical : INT* optional, out -> Pointer<Int32>
// piLogicalToVisual : INT* optional, out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ScriptLayout(
  cRuns: Integer;   // INT
  pbLevel: Pointer;   // BYTE*
  piVisualToLogical: Pointer;   // INT* optional, out
  piLogicalToVisual: Pointer   // INT* optional, out
): Integer; stdcall;
  external 'USP10.dll' name 'ScriptLayout';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ScriptLayout"
  c_ScriptLayout :: Int32 -> Ptr Word8 -> Ptr Int32 -> Ptr Int32 -> IO Int32
-- cRuns : INT -> Int32
-- pbLevel : BYTE* -> Ptr Word8
-- piVisualToLogical : INT* optional, out -> Ptr Int32
-- piLogicalToVisual : INT* optional, out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let scriptlayout =
  foreign "ScriptLayout"
    (int32_t @-> (ptr uint8_t) @-> (ptr int32_t) @-> (ptr int32_t) @-> returning int32_t)
(* cRuns : INT -> int32_t *)
(* pbLevel : BYTE* -> (ptr uint8_t) *)
(* piVisualToLogical : INT* optional, out -> (ptr int32_t) *)
(* piLogicalToVisual : INT* optional, out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library usp10 (t "USP10.dll"))
(cffi:use-foreign-library usp10)

(cffi:defcfun ("ScriptLayout" script-layout :convention :stdcall) :int32
  (c-runs :int32)   ; INT
  (pb-level :pointer)   ; BYTE*
  (pi-visual-to-logical :pointer)   ; INT* optional, out
  (pi-logical-to-visual :pointer))   ; INT* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ScriptLayout = Win32::API::More->new('USP10',
    'int ScriptLayout(int cRuns, LPVOID pbLevel, LPVOID piVisualToLogical, LPVOID piLogicalToVisual)');
# my $ret = $ScriptLayout->Call($cRuns, $pbLevel, $piVisualToLogical, $piLogicalToVisual);
# cRuns : INT -> int
# pbLevel : BYTE* -> LPVOID
# piVisualToLogical : INT* optional, out -> LPVOID
# piLogicalToVisual : INT* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。