ScriptXtoCP

関数

表示上のX座標から文字位置を算出する。

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

シグネチャ

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

HRESULT ScriptXtoCP(
    INT iX,
    INT cChars,
    INT cGlyphs,
    const WORD* pwLogClust,
    const SCRIPT_VISATTR* psva,
    const INT* piAdvance,
    const SCRIPT_ANALYSIS* psa,
    INT* piCP,
    INT* piTrailing
);

パラメーター

名前	型	方向	説明
iX	INT	in	psa パラメーターで指定される SCRIPT_ANALYSIS 構造体の fLogicalOrder メンバーで指定されるランの末尾からの、論理単位でのオフセット。
cChars	INT	in	ラン内の論理コードポイントの数。
cGlyphs	INT	in	ラン内のグリフの数。
pwLogClust	WORD*	in	論理クラスタの配列へのポインター。
psva	SCRIPT_VISATTR*	in	グリフの視覚属性を含む SCRIPT_VISATTR 構造体の配列へのポインター。
piAdvance	INT*	in	送り幅(advance width)の配列へのポインター。
psa	SCRIPT_ANALYSIS*	in	SCRIPT_ANALYSIS 構造体へのポインター。fLogicalOrder メンバーは、ランの先頭側エッジを使用する場合は TRUE、末尾側エッジを使用する場合は FALSE を示します。
piCP	INT*	out	この関数が x 座標に対応する文字位置を取得するためのバッファーへのポインター。
piTrailing	INT*	out	この関数が、論理文字の先頭側エッジから iX 位置までの距離をコードポイント単位で取得するためのバッファーへのポインター。この値が 0 の場合、iX 位置は論理文字の先頭側エッジにあります。詳細については「解説」セクションを参照してください。

戻り値の型: HRESULT

公式ドキュメント

ラン(run)の x オフセットから、論理文字クラスタの先頭側エッジまたは末尾側エッジを生成します。

戻り値

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

解説(Remarks)

この関数に渡す値は、通常、他の Uniscribe 関数を以前に呼び出した結果です。詳細については「Managing Caret Placement and Hit Testing」を参照してください。

論理文字の先頭側エッジと末尾側エッジは、ラン内のテキストの方向(左から右、または右から左)によって決まります。左から右の方向では、先頭側エッジは左エッジと同じです。右から左の方向では、先頭側エッジは右エッジになります。

アラビア語やヘブライ語など、キャレットが慣習的にクラスタの中間に配置されるスクリプトでは、取得される文字位置は行内の任意のコードポイントになり得ます。この場合、piTrailing パラメーターは 0 または 1 のいずれかに設定されます。

キャレットが慣習的にクラスタの境界にスナップされるスクリプトでは、取得される文字位置は常に(論理的に見て)クラスタ内の最初のコードポイントの位置になります。piTrailing パラメーターは 0、またはクラスタ内のコードポイント数に設定されます。

マウスヒットに対する適切なキャレット位置は、常に、取得された文字位置に piTrailing で示される距離を加えたものです。

iX がランの外側の位置を示す場合、ScriptXtoCP は、ランの両端の先に無限に大きな文字が 1 つ余分に存在するかのように動作します。これにより、次の表に示す動作になります。

iX 位置(ランの外側)	結果
ランの前。すなわち、ランが左から右の場合は iX < 0、ランが右から左の場合は iX >= 送り幅の合計	piCP の値は -1、piTrailing の値は 0
ランの後。すなわち、ランが左から右の場合は iX >= 送り幅の合計、ランが右から左の場合は iX < 0	piCP の値は cChars の値、piTrailing の値は 1

重要 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 ScriptXtoCP(
    INT iX,
    INT cChars,
    INT cGlyphs,
    const WORD* pwLogClust,
    const SCRIPT_VISATTR* psva,
    const INT* piAdvance,
    const SCRIPT_ANALYSIS* psa,
    INT* piCP,
    INT* piTrailing
);

[DllImport("USP10.dll", ExactSpelling = true)]
static extern int ScriptXtoCP(
    int iX,   // INT
    int cChars,   // INT
    int cGlyphs,   // INT
    ref ushort pwLogClust,   // WORD*
    IntPtr psva,   // SCRIPT_VISATTR*
    ref int piAdvance,   // INT*
    IntPtr psa,   // SCRIPT_ANALYSIS*
    out int piCP,   // INT* out
    out int piTrailing   // INT* out
);

<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptXtoCP(
    iX As Integer,   ' INT
    cChars As Integer,   ' INT
    cGlyphs As Integer,   ' INT
    ByRef pwLogClust As UShort,   ' WORD*
    psva As IntPtr,   ' SCRIPT_VISATTR*
    ByRef piAdvance As Integer,   ' INT*
    psa As IntPtr,   ' SCRIPT_ANALYSIS*
    <Out> ByRef piCP As Integer,   ' INT* out
    <Out> ByRef piTrailing As Integer   ' INT* out
) As Integer
End Function

' iX : INT
' cChars : INT
' cGlyphs : INT
' pwLogClust : WORD*
' psva : SCRIPT_VISATTR*
' piAdvance : INT*
' psa : SCRIPT_ANALYSIS*
' piCP : INT* out
' piTrailing : INT* out
Declare PtrSafe Function ScriptXtoCP Lib "usp10" ( _
    ByVal iX As Long, _
    ByVal cChars As Long, _
    ByVal cGlyphs As Long, _
    ByRef pwLogClust As Integer, _
    ByVal psva As LongPtr, _
    ByRef piAdvance As Long, _
    ByVal psa As LongPtr, _
    ByRef piCP 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

ScriptXtoCP = ctypes.windll.usp10.ScriptXtoCP
ScriptXtoCP.restype = ctypes.c_int
ScriptXtoCP.argtypes = [
    ctypes.c_int,  # iX : INT
    ctypes.c_int,  # cChars : INT
    ctypes.c_int,  # cGlyphs : INT
    ctypes.POINTER(ctypes.c_ushort),  # pwLogClust : WORD*
    ctypes.c_void_p,  # psva : SCRIPT_VISATTR*
    ctypes.POINTER(ctypes.c_int),  # piAdvance : INT*
    ctypes.c_void_p,  # psa : SCRIPT_ANALYSIS*
    ctypes.POINTER(ctypes.c_int),  # piCP : INT* out
    ctypes.POINTER(ctypes.c_int),  # piTrailing : INT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USP10.dll')
ScriptXtoCP = Fiddle::Function.new(
  lib['ScriptXtoCP'],
  [
    Fiddle::TYPE_INT,  # iX : INT
    Fiddle::TYPE_INT,  # cChars : INT
    Fiddle::TYPE_INT,  # cGlyphs : INT
    Fiddle::TYPE_VOIDP,  # pwLogClust : WORD*
    Fiddle::TYPE_VOIDP,  # psva : SCRIPT_VISATTR*
    Fiddle::TYPE_VOIDP,  # piAdvance : INT*
    Fiddle::TYPE_VOIDP,  # psa : SCRIPT_ANALYSIS*
    Fiddle::TYPE_VOIDP,  # piCP : INT* out
    Fiddle::TYPE_VOIDP,  # piTrailing : INT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "usp10")]
extern "system" {
    fn ScriptXtoCP(
        iX: i32,  // INT
        cChars: i32,  // INT
        cGlyphs: i32,  // INT
        pwLogClust: *const u16,  // WORD*
        psva: *const SCRIPT_VISATTR,  // SCRIPT_VISATTR*
        piAdvance: *const i32,  // INT*
        psa: *const SCRIPT_ANALYSIS,  // SCRIPT_ANALYSIS*
        piCP: *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 ScriptXtoCP(int iX, int cChars, int cGlyphs, ref ushort pwLogClust, IntPtr psva, ref int piAdvance, IntPtr psa, out int piCP, out int piTrailing);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USP10_ScriptXtoCP' -Namespace Win32 -PassThru
# $api::ScriptXtoCP(iX, cChars, cGlyphs, pwLogClust, psva, piAdvance, psa, piCP, piTrailing)

#uselib "USP10.dll"
#func global ScriptXtoCP "ScriptXtoCP" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; ScriptXtoCP iX, cChars, cGlyphs, varptr(pwLogClust), varptr(psva), varptr(piAdvance), varptr(psa), varptr(piCP), varptr(piTrailing)   ; 戻り値は stat
; iX : INT -> "sptr"
; cChars : INT -> "sptr"
; cGlyphs : INT -> "sptr"
; pwLogClust : WORD* -> "sptr"
; psva : SCRIPT_VISATTR* -> "sptr"
; piAdvance : INT* -> "sptr"
; psa : SCRIPT_ANALYSIS* -> "sptr"
; piCP : INT* out -> "sptr"
; piTrailing : INT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USP10.dll"
#cfunc global ScriptXtoCP "ScriptXtoCP" int, int, int, var, var, var, var, var, var
; res = ScriptXtoCP(iX, cChars, cGlyphs, pwLogClust, psva, piAdvance, psa, piCP, piTrailing)
; iX : INT -> "int"
; cChars : INT -> "int"
; cGlyphs : INT -> "int"
; pwLogClust : WORD* -> "var"
; psva : SCRIPT_VISATTR* -> "var"
; piAdvance : INT* -> "var"
; psa : SCRIPT_ANALYSIS* -> "var"
; piCP : INT* out -> "var"
; piTrailing : INT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USP10.dll"
#cfunc global ScriptXtoCP "ScriptXtoCP" int, int, int, sptr, sptr, sptr, sptr, sptr, sptr
; res = ScriptXtoCP(iX, cChars, cGlyphs, varptr(pwLogClust), varptr(psva), varptr(piAdvance), varptr(psa), varptr(piCP), varptr(piTrailing))
; iX : INT -> "int"
; cChars : INT -> "int"
; cGlyphs : INT -> "int"
; pwLogClust : WORD* -> "sptr"
; psva : SCRIPT_VISATTR* -> "sptr"
; piAdvance : INT* -> "sptr"
; psa : SCRIPT_ANALYSIS* -> "sptr"
; piCP : INT* out -> "sptr"
; piTrailing : INT* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。