ScriptCPtoX

関数

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

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

シグネチャ

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

HRESULT ScriptCPtoX(
    INT iCP,
    BOOL fTrailing,
    INT cChars,
    INT cGlyphs,
    const WORD* pwLogClust,
    const SCRIPT_VISATTR* psva,
    const INT* piAdvance,
    const SCRIPT_ANALYSIS* psa,
    INT* piX
);

パラメーター

名前	型	方向	説明
iCP	INT	in	ラン内の論理文字位置。このパラメーターは、クラスタ内の任意の論理文字のオフセットに対応します。
fTrailing	BOOL	in	論理文字クラスタの末尾エッジを使用してオフセットを計算する場合は TRUE を指定します。論理文字クラスタの先頭エッジを使用する場合は、このパラメーターを FALSE に設定します。
cChars	INT	in	ラン内の文字数。
cGlyphs	INT	in	ラン内のグリフ数。
pwLogClust	WORD*	in	論理クラスタへのポインター。
psva	SCRIPT_VISATTR*	in	視覚属性の SCRIPT_VISATTR 配列へのポインター。
piAdvance	INT*	in	アドバンス幅の値へのポインター。
psa	SCRIPT_ANALYSIS*	in	SCRIPT_ANALYSIS 構造体へのポインター。fLogicalOrder メンバーは、オフセットを測定するランの端を指定します。このフラグが設定されている場合は、ランの先頭エッジが使用されます。フラグが設定されていない場合は、ランの左端が使用されます。
piX	INT*	inout	この関数がキャレットの x 位置を取得するバッファーへのポインター。

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

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

解説(Remarks)

文字の先頭エッジまたは末尾エッジと、ランの先頭エッジは、ラン内のテキストの方向に依存します。

キャレットを慣例的にクラスタの中央に配置するスクリプト(例: アラビア語およびヘブライ語)では、取得されるキャレットの x 位置は、行内の任意のコードポイントに対して補間された位置になることがあります。

キャレットを慣例的にクラスタの境界にスナップするスクリプト(例: タイ語およびインド系言語)では、x 位置は、iCP で示される論理文字位置を含むクラスタの要求されたエッジにスナップされます。

重要 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 ScriptCPtoX(
    INT iCP,
    BOOL fTrailing,
    INT cChars,
    INT cGlyphs,
    const WORD* pwLogClust,
    const SCRIPT_VISATTR* psva,
    const INT* piAdvance,
    const SCRIPT_ANALYSIS* psa,
    INT* piX
);

[DllImport("USP10.dll", ExactSpelling = true)]
static extern int ScriptCPtoX(
    int iCP,   // INT
    bool fTrailing,   // BOOL
    int cChars,   // INT
    int cGlyphs,   // INT
    ref ushort pwLogClust,   // WORD*
    IntPtr psva,   // SCRIPT_VISATTR*
    ref int piAdvance,   // INT*
    IntPtr psa,   // SCRIPT_ANALYSIS*
    ref int piX   // INT* in/out
);

<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptCPtoX(
    iCP As Integer,   ' INT
    fTrailing As Boolean,   ' BOOL
    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*
    ByRef piX As Integer   ' INT* in/out
) As Integer
End Function

' iCP : INT
' fTrailing : BOOL
' cChars : INT
' cGlyphs : INT
' pwLogClust : WORD*
' psva : SCRIPT_VISATTR*
' piAdvance : INT*
' psa : SCRIPT_ANALYSIS*
' piX : INT* in/out
Declare PtrSafe Function ScriptCPtoX Lib "usp10" ( _
    ByVal iCP As Long, _
    ByVal fTrailing 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 piX As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScriptCPtoX = ctypes.windll.usp10.ScriptCPtoX
ScriptCPtoX.restype = ctypes.c_int
ScriptCPtoX.argtypes = [
    ctypes.c_int,  # iCP : INT
    wintypes.BOOL,  # fTrailing : BOOL
    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),  # piX : INT* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USP10.dll')
ScriptCPtoX = Fiddle::Function.new(
  lib['ScriptCPtoX'],
  [
    Fiddle::TYPE_INT,  # iCP : INT
    Fiddle::TYPE_INT,  # fTrailing : BOOL
    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,  # piX : INT* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "usp10")]
extern "system" {
    fn ScriptCPtoX(
        iCP: i32,  // INT
        fTrailing: i32,  // BOOL
        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*
        piX: *mut i32  // INT* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USP10.dll")]
public static extern int ScriptCPtoX(int iCP, bool fTrailing, int cChars, int cGlyphs, ref ushort pwLogClust, IntPtr psva, ref int piAdvance, IntPtr psa, ref int piX);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USP10_ScriptCPtoX' -Namespace Win32 -PassThru
# $api::ScriptCPtoX(iCP, fTrailing, cChars, cGlyphs, pwLogClust, psva, piAdvance, psa, piX)

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

出力引数:

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