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

ScriptStringXtoCP

関数
解析済み文字列でX座標から文字位置を算出する。
DLLUSP10.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT ScriptStringXtoCP(
    void* ssa,
    INT iX,
    INT* piCh,
    INT* piTrailing
);

パラメーター

名前方向説明
ssavoid*in文字列に対応する SCRIPT_STRING_ANALYSIS 構造体です。
iXINTinx 座標です。
piChINT*outx 座標に対応する文字位置をこの関数が取得して格納する変数へのポインターです。
piTrailingINT*outx 座標が文字位置の前縁(leading edge)と後縁(trailing edge)のどちらに対応するかを示す値を、この関数が取得して格納する変数へのポインターです。詳細については「解説」の節を参照してください。

戻り値の型: HRESULT

公式ドキュメント

x 座標を文字位置に変換します。

戻り値

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

解説(Remarks)

x 座標が文字の前縁に対応する場合、piTrailing の値は 0 になります。x 座標が文字の後縁に対応する場合、piTrailing の値は正の整数になります。ScriptXtoCP と同様に、単独で描画できる文字の場合は値が 1 になります。クラスター内にカーソルを配置しないスクリプトにおいて文字がクラスターの一部である場合は値が 1 より大きくなり、次の有効な論理カーソル位置までのオフセットを示します。

x 座標が行の先頭より前にある場合、この関数は piCh に -1 を、piTrailing に 1 を取得します。これは、行の前にある存在しない文字の後縁を示します。x 座標が行の末尾より後にある場合、この関数は piCh に行の長さを超える最初のインデックスを、piTrailing に 0 を取得します。値 0 は、行の後にある存在しない文字の前縁を示します。

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

ScriptStringXtoCP = ctypes.windll.usp10.ScriptStringXtoCP
ScriptStringXtoCP.restype = ctypes.c_int
ScriptStringXtoCP.argtypes = [
    ctypes.POINTER(None),  # ssa : void*
    ctypes.c_int,  # iX : INT
    ctypes.POINTER(ctypes.c_int),  # piCh : INT* out
    ctypes.POINTER(ctypes.c_int),  # piTrailing : INT* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	usp10 = windows.NewLazySystemDLL("USP10.dll")
	procScriptStringXtoCP = usp10.NewProc("ScriptStringXtoCP")
)

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

extern "usp10" fn ScriptStringXtoCP(
    ssa: ?*anyopaque, // void*
    iX: i32, // INT
    piCh: [*c]i32, // INT* out
    piTrailing: [*c]i32 // INT* out
) callconv(std.os.windows.WINAPI) i32;
proc ScriptStringXtoCP(
    ssa: pointer,  # void*
    iX: int32,  # INT
    piCh: ptr int32,  # INT* out
    piTrailing: ptr int32  # INT* out
): int32 {.importc: "ScriptStringXtoCP", stdcall, dynlib: "USP10.dll".}
pragma(lib, "usp10");
extern(Windows)
int ScriptStringXtoCP(
    void* ssa,   // void*
    int iX,   // INT
    int* piCh,   // INT* out
    int* piTrailing   // INT* out
);
ccall((:ScriptStringXtoCP, "USP10.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32, Ptr{Int32}, Ptr{Int32}),
      ssa, iX, piCh, piTrailing)
# ssa : void* -> Ptr{Cvoid}
# iX : INT -> Int32
# piCh : INT* out -> Ptr{Int32}
# piTrailing : INT* out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ScriptStringXtoCP(
    void* ssa,
    int32_t iX,
    int32_t* piCh,
    int32_t* piTrailing);
]]
local usp10 = ffi.load("usp10")
-- usp10.ScriptStringXtoCP(ssa, iX, piCh, piTrailing)
-- ssa : void*
-- iX : INT
-- piCh : INT* out
-- piTrailing : INT* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USP10.dll');
const ScriptStringXtoCP = lib.func('__stdcall', 'ScriptStringXtoCP', 'int32_t', ['void *', 'int32_t', 'int32_t *', 'int32_t *']);
// ScriptStringXtoCP(ssa, iX, piCh, piTrailing)
// ssa : void* -> 'void *'
// iX : INT -> 'int32_t'
// piCh : INT* out -> 'int32_t *'
// piTrailing : INT* out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USP10.dll", {
  ScriptStringXtoCP: { parameters: ["pointer", "i32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.ScriptStringXtoCP(ssa, iX, piCh, piTrailing)
// ssa : void* -> "pointer"
// iX : INT -> "i32"
// piCh : INT* out -> "pointer"
// piTrailing : INT* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ScriptStringXtoCP(
    void* ssa,
    int32_t iX,
    int32_t* piCh,
    int32_t* piTrailing);
C, "USP10.dll");
// $ffi->ScriptStringXtoCP(ssa, iX, piCh, piTrailing);
// ssa : void*
// iX : INT
// piCh : INT* out
// piTrailing : 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 ScriptStringXtoCP(
        Pointer ssa,   // void*
        int iX,   // INT
        IntByReference piCh,   // INT* out
        IntByReference piTrailing   // INT* out
    );
}
@[Link("usp10")]
lib LibUSP10
  fun ScriptStringXtoCP = ScriptStringXtoCP(
    ssa : Void*,   # void*
    iX : Int32,   # INT
    piCh : Int32*,   # INT* out
    piTrailing : 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 ScriptStringXtoCPNative = Int32 Function(Pointer<Void>, Int32, Pointer<Int32>, Pointer<Int32>);
typedef ScriptStringXtoCPDart = int Function(Pointer<Void>, int, Pointer<Int32>, Pointer<Int32>);
final ScriptStringXtoCP = DynamicLibrary.open('USP10.dll')
    .lookupFunction<ScriptStringXtoCPNative, ScriptStringXtoCPDart>('ScriptStringXtoCP');
// ssa : void* -> Pointer<Void>
// iX : INT -> Int32
// piCh : INT* out -> Pointer<Int32>
// piTrailing : INT* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ScriptStringXtoCP(
  ssa: Pointer;   // void*
  iX: Integer;   // INT
  piCh: Pointer;   // INT* out
  piTrailing: Pointer   // INT* out
): Integer; stdcall;
  external 'USP10.dll' name 'ScriptStringXtoCP';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ScriptStringXtoCP"
  c_ScriptStringXtoCP :: Ptr () -> Int32 -> Ptr Int32 -> Ptr Int32 -> IO Int32
-- ssa : void* -> Ptr ()
-- iX : INT -> Int32
-- piCh : INT* out -> Ptr Int32
-- piTrailing : INT* out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let scriptstringxtocp =
  foreign "ScriptStringXtoCP"
    ((ptr void) @-> int32_t @-> (ptr int32_t) @-> (ptr int32_t) @-> returning int32_t)
(* ssa : void* -> (ptr void) *)
(* iX : INT -> int32_t *)
(* piCh : INT* out -> (ptr int32_t) *)
(* piTrailing : 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 ("ScriptStringXtoCP" script-string-xto-cp :convention :stdcall) :int32
  (ssa :pointer)   ; void*
  (i-x :int32)   ; INT
  (pi-ch :pointer)   ; INT* out
  (pi-trailing :pointer))   ; INT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ScriptStringXtoCP = Win32::API::More->new('USP10',
    'int ScriptStringXtoCP(LPVOID ssa, int iX, LPVOID piCh, LPVOID piTrailing)');
# my $ret = $ScriptStringXtoCP->Call($ssa, $iX, $piCh, $piTrailing);
# ssa : void* -> LPVOID
# iX : INT -> int
# piCh : INT* out -> LPVOID
# piTrailing : INT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。