ホーム › Globalization › ScriptGetLogicalWidths

ScriptGetLogicalWidths

関数

グリフ幅から各文字の論理幅を算出する。

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

シグネチャ

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

HRESULT ScriptGetLogicalWidths(
    const SCRIPT_ANALYSIS* psa,
    INT cChars,
    INT cGlyphs,
    const INT* piGlyphWidth,
    const WORD* pwLogClust,
    const SCRIPT_VISATTR* psva,
    INT* piDx
);

パラメーター

名前	型	方向	説明
psa	SCRIPT_ANALYSIS*	in	SCRIPT_ANALYSIS 構造体へのポインター。
cChars	INT	in	ラン内の論理コードポイントの数。
cGlyphs	INT	in	ラン内のグリフの数。
piGlyphWidth	INT*	in	グリフ送り幅の配列へのポインター。
pwLogClust	WORD*	in	論理クラスターの配列へのポインター。
psva	SCRIPT_VISATTR*	in	視覚属性を定義する SCRIPT_VISATTR 構造体へのポインター。
piDx	INT*	in	論理幅の配列へのポインター。

戻り値の型: HRESULT

公式ドキュメント

特定のフォントのグリフ送り幅を論理幅に変換します。

戻り値

現在はすべての場合で S_OK を返します。

解説(Remarks)

この関数は、幅をフォントに依存しない形で記録するのに役立ちます。特定のフォントに対して計算されたグリフ送り幅を、コードポイントと同じ順序で、コードポイントごとに 1 つずつの論理幅に変換します。同じ文字列を別のフォントを使用して別のデバイス上に表示する場合、ScriptApplyLogicalWidth を使用してこの論理幅を適用することで、元の配置を近似できます。この仕組みは印刷プレビューを実装する際に役立ちます。プレビュー画面では、最終的な印刷結果のレイアウトと配置を一致させることが重要です。

注意合字グリフの幅は、それが表す文字間で均等に分割されます。

重要 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 ScriptGetLogicalWidths(
    const SCRIPT_ANALYSIS* psa,
    INT cChars,
    INT cGlyphs,
    const INT* piGlyphWidth,
    const WORD* pwLogClust,
    const SCRIPT_VISATTR* psva,
    INT* piDx
);

[DllImport("USP10.dll", ExactSpelling = true)]
static extern int ScriptGetLogicalWidths(
    IntPtr psa,   // SCRIPT_ANALYSIS*
    int cChars,   // INT
    int cGlyphs,   // INT
    ref int piGlyphWidth,   // INT*
    ref ushort pwLogClust,   // WORD*
    IntPtr psva,   // SCRIPT_VISATTR*
    ref int piDx   // INT*
);

<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptGetLogicalWidths(
    psa As IntPtr,   ' SCRIPT_ANALYSIS*
    cChars As Integer,   ' INT
    cGlyphs As Integer,   ' INT
    ByRef piGlyphWidth As Integer,   ' INT*
    ByRef pwLogClust As UShort,   ' WORD*
    psva As IntPtr,   ' SCRIPT_VISATTR*
    ByRef piDx As Integer   ' INT*
) As Integer
End Function

' psa : SCRIPT_ANALYSIS*
' cChars : INT
' cGlyphs : INT
' piGlyphWidth : INT*
' pwLogClust : WORD*
' psva : SCRIPT_VISATTR*
' piDx : INT*
Declare PtrSafe Function ScriptGetLogicalWidths Lib "usp10" ( _
    ByVal psa As LongPtr, _
    ByVal cChars As Long, _
    ByVal cGlyphs As Long, _
    ByRef piGlyphWidth As Long, _
    ByRef pwLogClust As Integer, _
    ByVal psva As LongPtr, _
    ByRef piDx As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScriptGetLogicalWidths = ctypes.windll.usp10.ScriptGetLogicalWidths
ScriptGetLogicalWidths.restype = ctypes.c_int
ScriptGetLogicalWidths.argtypes = [
    ctypes.c_void_p,  # psa : SCRIPT_ANALYSIS*
    ctypes.c_int,  # cChars : INT
    ctypes.c_int,  # cGlyphs : INT
    ctypes.POINTER(ctypes.c_int),  # piGlyphWidth : INT*
    ctypes.POINTER(ctypes.c_ushort),  # pwLogClust : WORD*
    ctypes.c_void_p,  # psva : SCRIPT_VISATTR*
    ctypes.POINTER(ctypes.c_int),  # piDx : INT*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USP10.dll')
ScriptGetLogicalWidths = Fiddle::Function.new(
  lib['ScriptGetLogicalWidths'],
  [
    Fiddle::TYPE_VOIDP,  # psa : SCRIPT_ANALYSIS*
    Fiddle::TYPE_INT,  # cChars : INT
    Fiddle::TYPE_INT,  # cGlyphs : INT
    Fiddle::TYPE_VOIDP,  # piGlyphWidth : INT*
    Fiddle::TYPE_VOIDP,  # pwLogClust : WORD*
    Fiddle::TYPE_VOIDP,  # psva : SCRIPT_VISATTR*
    Fiddle::TYPE_VOIDP,  # piDx : INT*
  ],
  Fiddle::TYPE_INT)

#[link(name = "usp10")]
extern "system" {
    fn ScriptGetLogicalWidths(
        psa: *const SCRIPT_ANALYSIS,  // SCRIPT_ANALYSIS*
        cChars: i32,  // INT
        cGlyphs: i32,  // INT
        piGlyphWidth: *const i32,  // INT*
        pwLogClust: *const u16,  // WORD*
        psva: *const SCRIPT_VISATTR,  // SCRIPT_VISATTR*
        piDx: *mut i32  // INT*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

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

出力引数:

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