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

ScriptStringGetOrder

関数
解析済み文字列の視覚順インデックス配列を取得する。
DLLUSP10.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT ScriptStringGetOrder(
    void* ssa,
    DWORD* puOrder
);

パラメーター

名前方向説明
ssavoid*in文字列に対応する SCRIPT_STRING_ANALYSIS 構造体。
puOrderDWORD*inoutこの関数が、元の文字位置をインデックスとするグリフ位置の配列を取得するバッファーへのポインター。配列には、ScriptString_pcOutCharsssa パラメーターで示される個数以上の整数を格納できる領域が必要です。

戻り値の型: HRESULT

公式ドキュメント

元の文字位置をグリフ位置にマッピングする配列を作成します。

戻り値

成功した場合は S_OK を返します。成功しなかった場合、この関数は 0 以外の HRESULT 値を返します。アプリケーションは、SUCCEEDED マクロと FAILED マクロを使用して戻り値を検査できます。

解説(Remarks)

グリフ数と文字数が等しい場合、この関数はすべてのグリフを参照する配列を取得します。これは GetCharacterPlacement と同じ扱いです。

この関数を使用するには、ScriptStringAnalyse への最初の呼び出しで SSA_GLYPHS を指定する必要があります。

重要 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 ScriptStringGetOrder(
    void* ssa,
    DWORD* puOrder
);
[DllImport("USP10.dll", ExactSpelling = true)]
static extern int ScriptStringGetOrder(
    IntPtr ssa,   // void*
    ref uint puOrder   // DWORD* in/out
);
<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptStringGetOrder(
    ssa As IntPtr,   ' void*
    ByRef puOrder As UInteger   ' DWORD* in/out
) As Integer
End Function
' ssa : void*
' puOrder : DWORD* in/out
Declare PtrSafe Function ScriptStringGetOrder Lib "usp10" ( _
    ByVal ssa As LongPtr, _
    ByRef puOrder As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ScriptStringGetOrder = ctypes.windll.usp10.ScriptStringGetOrder
ScriptStringGetOrder.restype = ctypes.c_int
ScriptStringGetOrder.argtypes = [
    ctypes.POINTER(None),  # ssa : void*
    ctypes.POINTER(wintypes.DWORD),  # puOrder : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	usp10 = windows.NewLazySystemDLL("USP10.dll")
	procScriptStringGetOrder = usp10.NewProc("ScriptStringGetOrder")
)

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

extern "usp10" fn ScriptStringGetOrder(
    ssa: ?*anyopaque, // void*
    puOrder: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) i32;
proc ScriptStringGetOrder(
    ssa: pointer,  # void*
    puOrder: ptr uint32  # DWORD* in/out
): int32 {.importc: "ScriptStringGetOrder", stdcall, dynlib: "USP10.dll".}
pragma(lib, "usp10");
extern(Windows)
int ScriptStringGetOrder(
    void* ssa,   // void*
    uint* puOrder   // DWORD* in/out
);
ccall((:ScriptStringGetOrder, "USP10.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{UInt32}),
      ssa, puOrder)
# ssa : void* -> Ptr{Cvoid}
# puOrder : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ScriptStringGetOrder(
    void* ssa,
    uint32_t* puOrder);
]]
local usp10 = ffi.load("usp10")
-- usp10.ScriptStringGetOrder(ssa, puOrder)
-- ssa : void*
-- puOrder : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USP10.dll');
const ScriptStringGetOrder = lib.func('__stdcall', 'ScriptStringGetOrder', 'int32_t', ['void *', 'uint32_t *']);
// ScriptStringGetOrder(ssa, puOrder)
// ssa : void* -> 'void *'
// puOrder : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USP10.dll", {
  ScriptStringGetOrder: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.ScriptStringGetOrder(ssa, puOrder)
// ssa : void* -> "pointer"
// puOrder : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ScriptStringGetOrder(
    void* ssa,
    uint32_t* puOrder);
C, "USP10.dll");
// $ffi->ScriptStringGetOrder(ssa, puOrder);
// ssa : void*
// puOrder : DWORD* in/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 ScriptStringGetOrder(
        Pointer ssa,   // void*
        IntByReference puOrder   // DWORD* in/out
    );
}
@[Link("usp10")]
lib LibUSP10
  fun ScriptStringGetOrder = ScriptStringGetOrder(
    ssa : Void*,   # void*
    puOrder : UInt32*   # DWORD* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ScriptStringGetOrderNative = Int32 Function(Pointer<Void>, Pointer<Uint32>);
typedef ScriptStringGetOrderDart = int Function(Pointer<Void>, Pointer<Uint32>);
final ScriptStringGetOrder = DynamicLibrary.open('USP10.dll')
    .lookupFunction<ScriptStringGetOrderNative, ScriptStringGetOrderDart>('ScriptStringGetOrder');
// ssa : void* -> Pointer<Void>
// puOrder : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ScriptStringGetOrder(
  ssa: Pointer;   // void*
  puOrder: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'USP10.dll' name 'ScriptStringGetOrder';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ScriptStringGetOrder"
  c_ScriptStringGetOrder :: Ptr () -> Ptr Word32 -> IO Int32
-- ssa : void* -> Ptr ()
-- puOrder : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let scriptstringgetorder =
  foreign "ScriptStringGetOrder"
    ((ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* ssa : void* -> (ptr void) *)
(* puOrder : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library usp10 (t "USP10.dll"))
(cffi:use-foreign-library usp10)

(cffi:defcfun ("ScriptStringGetOrder" script-string-get-order :convention :stdcall) :int32
  (ssa :pointer)   ; void*
  (pu-order :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ScriptStringGetOrder = Win32::API::More->new('USP10',
    'int ScriptStringGetOrder(LPVOID ssa, LPVOID puOrder)');
# my $ret = $ScriptStringGetOrder->Call($ssa, $puOrder);
# ssa : void* -> LPVOID
# puOrder : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目