ホーム › Globalization › ScriptGetFontAlternateGlyphs

ScriptGetFontAlternateGlyphs

関数

指定機能における代替グリフの一覧を取得する。

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

シグネチャ

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

HRESULT ScriptGetFontAlternateGlyphs(
    HDC hdc,   // optional
    void** psc,
    SCRIPT_ANALYSIS* psa,   // optional
    DWORD tagScript,
    DWORD tagLangSys,
    DWORD tagFeature,
    WORD wGlyphId,
    INT cMaxAlternates,
    WORD* pAlternateGlyphs,
    INT* pcAlternates
);

パラメーター

名前	型	方向	説明
hdc	HDC	inoptional	デバイスコンテキストへのハンドルです。詳細については、Caching を参照してください。
psc	void**	inout	スクリプトキャッシュを定義する SCRIPT_CACHE 構造体へのポインターです。
psa	SCRIPT_ANALYSIS*	inoptional	ScriptItemizeOpenType への以前の呼び出しから取得した SCRIPT_ANALYSIS 構造体へのポインターです。このパラメーターはシェーピングエンジンを識別し、代替グリフの配列を正しいスコープで作成できるようにします。あるいは、アプリケーションはこのパラメーターを NULL に設定して、フィルター処理されていない結果を受け取ることもできます。
tagScript	DWORD	in	代替グリフに関連付けられたスクリプトタグを定義する OPENTYPE_TAG 構造体です。
tagLangSys	DWORD	in	代替グリフに関連付けられた言語タグを定義する OPENTYPE_TAG 構造体です。
tagFeature	DWORD	in	代替グリフに関連付けられた機能タグを定義する OPENTYPE_TAG 構造体です。
wGlyphId	WORD	in	文字マップテーブルからマップされた元のグリフの識別子です。
cMaxAlternates	INT	in	pAlternateGlyphs で指定される配列の長さです。
pAlternateGlyphs	WORD*	out	この関数がグリフ識別子の配列を取得するバッファーへのポインターです。配列には元のグリフが含まれ、その後に代替グリフが続きます。最初の要素は常に元のグリフです。代替形式は配列へのインデックスによって識別されます。このインデックスは 1 より大きく、pcAlternates の値より小さい値です。ユーザーがユーザーインターフェイスから代替形式を選択すると、その代替グリフが対応する文字に適用され、レンダリングが再フォーマットされます。
pcAlternates	INT*	out	pAlternateGlyphs で指定される配列の要素数へのポインターです。

戻り値の型: HRESULT

公式ドキュメント

指定された文字に対して、指定された OpenType 機能を通じてアクセスできる代替グリフの一覧を取得します。

戻り値

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

代替グリフの数が cMaxAlternates の値を超える場合、この関数は E_OUTOFMEMORY で失敗します。アプリケーションは、より大きなバッファーで再度呼び出すことを試みることができます。

解説(Remarks)

代替グリフを使用する場合、アプリケーションはまず、いかなる機能タグも適用せずに元のグリフを再シェーピングし、その後で代替を選択します。元のグリフはベースグリフとして確立されます。別の代替が必要な場合、元のグリフは対応する代替リストとの照合に必要な情報を提供します。

代替グリフがベースグリフとして使用される場合、一致する出力リストは見つかりません。ユーザーインターフェイスは、別の代替を選択する機能を提供せずに、選択された最終形式を使用します。

ScriptGetFontAlternateGlyphs の動作は、ScriptSubstituteSingleGlyph によってエミュレートできます。アプリケーションは、グリフが置換される間、パラメーターを 1 つずつ試す必要があります。

Uniscribe でフォントをシェーピングする場合は、古い ScriptShape 関数よりも ScriptShapeOpenType が推奨されます。

重要 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 ScriptGetFontAlternateGlyphs(
    HDC hdc,   // optional
    void** psc,
    SCRIPT_ANALYSIS* psa,   // optional
    DWORD tagScript,
    DWORD tagLangSys,
    DWORD tagFeature,
    WORD wGlyphId,
    INT cMaxAlternates,
    WORD* pAlternateGlyphs,
    INT* pcAlternates
);

[DllImport("USP10.dll", ExactSpelling = true)]
static extern int ScriptGetFontAlternateGlyphs(
    IntPtr hdc,   // HDC optional
    IntPtr psc,   // void** in/out
    IntPtr psa,   // SCRIPT_ANALYSIS* optional
    uint tagScript,   // DWORD
    uint tagLangSys,   // DWORD
    uint tagFeature,   // DWORD
    ushort wGlyphId,   // WORD
    int cMaxAlternates,   // INT
    out ushort pAlternateGlyphs,   // WORD* out
    out int pcAlternates   // INT* out
);

<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptGetFontAlternateGlyphs(
    hdc As IntPtr,   ' HDC optional
    psc As IntPtr,   ' void** in/out
    psa As IntPtr,   ' SCRIPT_ANALYSIS* optional
    tagScript As UInteger,   ' DWORD
    tagLangSys As UInteger,   ' DWORD
    tagFeature As UInteger,   ' DWORD
    wGlyphId As UShort,   ' WORD
    cMaxAlternates As Integer,   ' INT
    <Out> ByRef pAlternateGlyphs As UShort,   ' WORD* out
    <Out> ByRef pcAlternates As Integer   ' INT* out
) As Integer
End Function

' hdc : HDC optional
' psc : void** in/out
' psa : SCRIPT_ANALYSIS* optional
' tagScript : DWORD
' tagLangSys : DWORD
' tagFeature : DWORD
' wGlyphId : WORD
' cMaxAlternates : INT
' pAlternateGlyphs : WORD* out
' pcAlternates : INT* out
Declare PtrSafe Function ScriptGetFontAlternateGlyphs Lib "usp10" ( _
    ByVal hdc As LongPtr, _
    ByVal psc As LongPtr, _
    ByVal psa As LongPtr, _
    ByVal tagScript As Long, _
    ByVal tagLangSys As Long, _
    ByVal tagFeature As Long, _
    ByVal wGlyphId As Integer, _
    ByVal cMaxAlternates As Long, _
    ByRef pAlternateGlyphs As Integer, _
    ByRef pcAlternates As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScriptGetFontAlternateGlyphs = ctypes.windll.usp10.ScriptGetFontAlternateGlyphs
ScriptGetFontAlternateGlyphs.restype = ctypes.c_int
ScriptGetFontAlternateGlyphs.argtypes = [
    wintypes.HANDLE,  # hdc : HDC optional
    ctypes.c_void_p,  # psc : void** in/out
    ctypes.c_void_p,  # psa : SCRIPT_ANALYSIS* optional
    wintypes.DWORD,  # tagScript : DWORD
    wintypes.DWORD,  # tagLangSys : DWORD
    wintypes.DWORD,  # tagFeature : DWORD
    ctypes.c_ushort,  # wGlyphId : WORD
    ctypes.c_int,  # cMaxAlternates : INT
    ctypes.POINTER(ctypes.c_ushort),  # pAlternateGlyphs : WORD* out
    ctypes.POINTER(ctypes.c_int),  # pcAlternates : INT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USP10.dll')
ScriptGetFontAlternateGlyphs = Fiddle::Function.new(
  lib['ScriptGetFontAlternateGlyphs'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC optional
    Fiddle::TYPE_VOIDP,  # psc : void** in/out
    Fiddle::TYPE_VOIDP,  # psa : SCRIPT_ANALYSIS* optional
    -Fiddle::TYPE_INT,  # tagScript : DWORD
    -Fiddle::TYPE_INT,  # tagLangSys : DWORD
    -Fiddle::TYPE_INT,  # tagFeature : DWORD
    -Fiddle::TYPE_SHORT,  # wGlyphId : WORD
    Fiddle::TYPE_INT,  # cMaxAlternates : INT
    Fiddle::TYPE_VOIDP,  # pAlternateGlyphs : WORD* out
    Fiddle::TYPE_VOIDP,  # pcAlternates : INT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "usp10")]
extern "system" {
    fn ScriptGetFontAlternateGlyphs(
        hdc: *mut core::ffi::c_void,  // HDC optional
        psc: *mut *mut (),  // void** in/out
        psa: *mut SCRIPT_ANALYSIS,  // SCRIPT_ANALYSIS* optional
        tagScript: u32,  // DWORD
        tagLangSys: u32,  // DWORD
        tagFeature: u32,  // DWORD
        wGlyphId: u16,  // WORD
        cMaxAlternates: i32,  // INT
        pAlternateGlyphs: *mut u16,  // WORD* out
        pcAlternates: *mut i32  // INT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USP10.dll")]
public static extern int ScriptGetFontAlternateGlyphs(IntPtr hdc, IntPtr psc, IntPtr psa, uint tagScript, uint tagLangSys, uint tagFeature, ushort wGlyphId, int cMaxAlternates, out ushort pAlternateGlyphs, out int pcAlternates);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USP10_ScriptGetFontAlternateGlyphs' -Namespace Win32 -PassThru
# $api::ScriptGetFontAlternateGlyphs(hdc, psc, psa, tagScript, tagLangSys, tagFeature, wGlyphId, cMaxAlternates, pAlternateGlyphs, pcAlternates)

#uselib "USP10.dll"
#func global ScriptGetFontAlternateGlyphs "ScriptGetFontAlternateGlyphs" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; ScriptGetFontAlternateGlyphs hdc, psc, varptr(psa), tagScript, tagLangSys, tagFeature, wGlyphId, cMaxAlternates, varptr(pAlternateGlyphs), varptr(pcAlternates)   ; 戻り値は stat
; hdc : HDC optional -> "sptr"
; psc : void** in/out -> "sptr"
; psa : SCRIPT_ANALYSIS* optional -> "sptr"
; tagScript : DWORD -> "sptr"
; tagLangSys : DWORD -> "sptr"
; tagFeature : DWORD -> "sptr"
; wGlyphId : WORD -> "sptr"
; cMaxAlternates : INT -> "sptr"
; pAlternateGlyphs : WORD* out -> "sptr"
; pcAlternates : INT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USP10.dll"
#cfunc global ScriptGetFontAlternateGlyphs "ScriptGetFontAlternateGlyphs" sptr, sptr, var, int, int, int, int, int, var, var
; res = ScriptGetFontAlternateGlyphs(hdc, psc, psa, tagScript, tagLangSys, tagFeature, wGlyphId, cMaxAlternates, pAlternateGlyphs, pcAlternates)
; hdc : HDC optional -> "sptr"
; psc : void** in/out -> "sptr"
; psa : SCRIPT_ANALYSIS* optional -> "var"
; tagScript : DWORD -> "int"
; tagLangSys : DWORD -> "int"
; tagFeature : DWORD -> "int"
; wGlyphId : WORD -> "int"
; cMaxAlternates : INT -> "int"
; pAlternateGlyphs : WORD* out -> "var"
; pcAlternates : INT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USP10.dll"
#cfunc global ScriptGetFontAlternateGlyphs "ScriptGetFontAlternateGlyphs" sptr, sptr, sptr, int, int, int, int, int, sptr, sptr
; res = ScriptGetFontAlternateGlyphs(hdc, psc, varptr(psa), tagScript, tagLangSys, tagFeature, wGlyphId, cMaxAlternates, varptr(pAlternateGlyphs), varptr(pcAlternates))
; hdc : HDC optional -> "sptr"
; psc : void** in/out -> "sptr"
; psa : SCRIPT_ANALYSIS* optional -> "sptr"
; tagScript : DWORD -> "int"
; tagLangSys : DWORD -> "int"
; tagFeature : DWORD -> "int"
; wGlyphId : WORD -> "int"
; cMaxAlternates : INT -> "int"
; pAlternateGlyphs : WORD* out -> "sptr"
; pcAlternates : INT* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。