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

ScriptGetProperties

関数
Uniscribeがサポートするスクリプトの属性を取得する。
DLLUSP10.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT ScriptGetProperties(
    const SCRIPT_PROPERTIES*** ppSp,
    INT* piNumScripts
);

パラメーター

名前方向説明
ppSpSCRIPT_PROPERTIES***outスクリプトでインデックス付けされた SCRIPT_PROPERTIES 構造体へのポインターの配列へのポインター。
piNumScriptsINT*outスクリプト数へのポインター。この値の有効範囲は 0 から piNumScripts-1 までです。

戻り値の型: HRESULT

公式ドキュメント

現在のスクリプトに関する情報を取得します。

戻り値

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

解説(Remarks)

この関数の使用例については、「Determining If a Script Requires Glyph Shaping」を参照してください。

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

ScriptGetProperties = ctypes.windll.usp10.ScriptGetProperties
ScriptGetProperties.restype = ctypes.c_int
ScriptGetProperties.argtypes = [
    ctypes.c_void_p,  # ppSp : SCRIPT_PROPERTIES*** out
    ctypes.POINTER(ctypes.c_int),  # piNumScripts : INT* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	usp10 = windows.NewLazySystemDLL("USP10.dll")
	procScriptGetProperties = usp10.NewProc("ScriptGetProperties")
)

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

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

typedef ScriptGetPropertiesNative = Int32 Function(Pointer<Void>, Pointer<Int32>);
typedef ScriptGetPropertiesDart = int Function(Pointer<Void>, Pointer<Int32>);
final ScriptGetProperties = DynamicLibrary.open('USP10.dll')
    .lookupFunction<ScriptGetPropertiesNative, ScriptGetPropertiesDart>('ScriptGetProperties');
// ppSp : SCRIPT_PROPERTIES*** out -> Pointer<Void>
// piNumScripts : INT* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ScriptGetProperties(
  ppSp: Pointer;   // SCRIPT_PROPERTIES*** out
  piNumScripts: Pointer   // INT* out
): Integer; stdcall;
  external 'USP10.dll' name 'ScriptGetProperties';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ScriptGetProperties"
  c_ScriptGetProperties :: Ptr () -> Ptr Int32 -> IO Int32
-- ppSp : SCRIPT_PROPERTIES*** out -> Ptr ()
-- piNumScripts : INT* out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let scriptgetproperties =
  foreign "ScriptGetProperties"
    ((ptr void) @-> (ptr int32_t) @-> returning int32_t)
(* ppSp : SCRIPT_PROPERTIES*** out -> (ptr void) *)
(* piNumScripts : INT* 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 ("ScriptGetProperties" script-get-properties :convention :stdcall) :int32
  (pp-sp :pointer)   ; SCRIPT_PROPERTIES*** out
  (pi-num-scripts :pointer))   ; INT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ScriptGetProperties = Win32::API::More->new('USP10',
    'int ScriptGetProperties(LPVOID ppSp, LPVOID piNumScripts)');
# my $ret = $ScriptGetProperties->Call($ppSp, $piNumScripts);
# ppSp : SCRIPT_PROPERTIES*** out -> LPVOID
# piNumScripts : INT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型