ホーム › Globalization › ScriptApplyLogicalWidth

ScriptApplyLogicalWidth

関数

文字の論理幅をグリフの送り幅に反映する。

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

シグネチャ

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

HRESULT ScriptApplyLogicalWidth(
    const INT* piDx,
    INT cChars,
    INT cGlyphs,
    const WORD* pwLogClust,
    const SCRIPT_VISATTR* psva,
    const INT* piAdvance,
    const SCRIPT_ANALYSIS* psa,
    ABC* pABC,   // optional
    INT* piJustify
);

パラメーター

名前	型	方向	説明
piDx	INT*	in	論理順に並んだ送り幅(advance width)の配列へのポインター。コードポイントごとに1つです。
cChars	INT	in	ラン内の論理コードポイントの数。
cGlyphs	INT	in	グリフ数。
pwLogClust	WORD*	in	ScriptShape から得られる論理クラスターの配列へのポインター。
psva	SCRIPT_VISATTR*	in	ScriptShape から得られ、ScriptPlace によって更新される SCRIPT_VISATTR 構造体へのポインター。
piAdvance	INT*	in	ScriptPlace から得られるグリフ送り幅の配列へのポインター。
psa	SCRIPT_ANALYSIS*	in	ScriptItemize から得られ、ScriptShape および ScriptPlace によって更新される SCRIPT_ANALYSIS 構造体へのポインター。
pABC	ABC*	inoutoptional	ラン全体の ABC幅へのポインター。入力時には、ScriptPlace によって取得されたランの ABC 幅を格納しておく必要があります。出力時には、新しい幅に合わせて更新された ABC 幅が格納されます。
piJustify	INT*	out	この関数がグリフ送り幅を取得する配列へのポインター。この配列は、ScriptTextOut の piJustify パラメーターに渡すのに適しています。

戻り値の型: HRESULT

公式ドキュメント

ラン(run)の送り幅(advance width)の配列を受け取り、調整済みのグリフ送り幅の配列を生成します。

戻り値

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

解説(Remarks)

この関数は、ScriptGetLogicalWidths で取得した論理幅を再適用するために使用できます。これは、メタファイルの作成のように、送り幅の情報を記録し、リガチャ化などのグリフ置換に依存せず、フォントに依存しない方法で再適用しなければならない状況で役立ちます。

重要 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 ScriptApplyLogicalWidth(
    const INT* piDx,
    INT cChars,
    INT cGlyphs,
    const WORD* pwLogClust,
    const SCRIPT_VISATTR* psva,
    const INT* piAdvance,
    const SCRIPT_ANALYSIS* psa,
    ABC* pABC,   // optional
    INT* piJustify
);

[DllImport("USP10.dll", ExactSpelling = true)]
static extern int ScriptApplyLogicalWidth(
    ref int piDx,   // INT*
    int cChars,   // INT
    int cGlyphs,   // INT
    ref ushort pwLogClust,   // WORD*
    IntPtr psva,   // SCRIPT_VISATTR*
    ref int piAdvance,   // INT*
    IntPtr psa,   // SCRIPT_ANALYSIS*
    IntPtr pABC,   // ABC* optional, in/out
    out int piJustify   // INT* out
);

<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptApplyLogicalWidth(
    ByRef piDx 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*
    pABC As IntPtr,   ' ABC* optional, in/out
    <Out> ByRef piJustify As Integer   ' INT* out
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

ScriptApplyLogicalWidth = ctypes.windll.usp10.ScriptApplyLogicalWidth
ScriptApplyLogicalWidth.restype = ctypes.c_int
ScriptApplyLogicalWidth.argtypes = [
    ctypes.POINTER(ctypes.c_int),  # piDx : 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.c_void_p,  # pABC : ABC* optional, in/out
    ctypes.POINTER(ctypes.c_int),  # piJustify : INT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USP10.dll')
ScriptApplyLogicalWidth = Fiddle::Function.new(
  lib['ScriptApplyLogicalWidth'],
  [
    Fiddle::TYPE_VOIDP,  # piDx : 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,  # pABC : ABC* optional, in/out
    Fiddle::TYPE_VOIDP,  # piJustify : INT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "usp10")]
extern "system" {
    fn ScriptApplyLogicalWidth(
        piDx: *const 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*
        pABC: *mut ABC,  // ABC* optional, in/out
        piJustify: *mut i32  // INT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USP10.dll")]
public static extern int ScriptApplyLogicalWidth(ref int piDx, int cChars, int cGlyphs, ref ushort pwLogClust, IntPtr psva, ref int piAdvance, IntPtr psa, IntPtr pABC, out int piJustify);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USP10_ScriptApplyLogicalWidth' -Namespace Win32 -PassThru
# $api::ScriptApplyLogicalWidth(piDx, cChars, cGlyphs, pwLogClust, psva, piAdvance, psa, pABC, piJustify)

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

出力引数:

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