ホーム › Globalization › ScriptGetFontScriptTags

ScriptGetFontScriptTags

関数

フォントが対応するOpenTypeスクリプトタグを取得する。

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

シグネチャ

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

HRESULT ScriptGetFontScriptTags(
    HDC hdc,   // optional
    void** psc,
    SCRIPT_ANALYSIS* psa,   // optional
    INT cMaxTags,
    DWORD* pScriptTags,
    INT* pcTags
);

パラメーター

名前	型	方向	説明
hdc	HDC	inoptional	デバイスコンテキストへのハンドル。詳細については、Caching を参照してください。
psc	void**	inout	スクリプトキャッシュを識別する SCRIPT_CACHE 構造体へのポインター。
psa	SCRIPT_ANALYSIS*	inoptional	ScriptItemizeOpenType への以前の呼び出しから取得した SCRIPT_ANALYSIS 構造体へのポインター。このパラメーターはシェイピングエンジンを識別し、適切なフォントスクリプトタグを取得できるようにします。アプリケーションは、現在のランに適したスクリプトタグを取得するために、このパラメーターに非 NULL の値を指定します。あるいは、フィルター処理されていない結果を取得するために、アプリケーションはこのパラメーターを NULL に設定することもできます。
cMaxTags	INT	in	pScriptTags で指定された配列の長さ。
pScriptTags	DWORD*	out	この関数が、デバイスコンテキストまたは現在のランに関連付けられたスクリプトエンジンからスクリプトタグを定義する OPENTYPE_TAG 構造体の配列を取得するバッファーへのポインター。psa パラメーターで指定された SCRIPT_ANALYSIS 構造体の eScript メンバーの値に明確なスクリプトタグが関連付けられており、そのタグがフォント内に存在する場合、pScriptTags にはこのタグのみが格納されます。
pcTags	INT*	out	pScriptTags で示されるスクリプトタグ配列内の要素数へのポインター。

戻り値の型: HRESULT

公式ドキュメント

OpenType 処理に利用できる、フォント内のスクリプトの一覧を取得します。一覧を構成するスクリプトは、指定されたデバイスコンテキスト内のフォントから、または現在のランのフォントを処理するスクリプトシェイピングエンジンから取得されます。

戻り値

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

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

解説(Remarks)

OPENTYPE_TAG は形式上は ULONG 型として宣言されていますが、スペース、A-Z、または a-z の 4 つの 8 ビット ASCII 値を含む 4 バイトの配列を定義します。たとえば、ラテン文字とアラビア文字のスクリプトタグは、それぞれ "latn" と "arab" です。

この関数は、次の場合にフォントから単一のタグを取得します。

psa の値が、単一の複雑なスクリプトのテキストに関連付けられている場合。
psa パラメーターが NULL を示し、フォントが単一のスクリプトをサポートしている場合。

ScriptGetFontScriptTags がフォントからすべてのタグを取得する場合、通常それらのタグは数字などの中立的な項目に対するものです。中立的な項目の一部のテキストランはスクリプト固有ではないため、複数のタグが該当する可能性があることに注意してください。

特定のスクリプトに対応するタグが存在する場合でも、シェイピングエンジンは、特定の言語システムや特定の機能などの必要な項目を欠いているために、そのフォントを使用して指定された項目をシェイプできないことがあります。

重要 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 ScriptGetFontScriptTags(
    HDC hdc,   // optional
    void** psc,
    SCRIPT_ANALYSIS* psa,   // optional
    INT cMaxTags,
    DWORD* pScriptTags,
    INT* pcTags
);

[DllImport("USP10.dll", ExactSpelling = true)]
static extern int ScriptGetFontScriptTags(
    IntPtr hdc,   // HDC optional
    IntPtr psc,   // void** in/out
    IntPtr psa,   // SCRIPT_ANALYSIS* optional
    int cMaxTags,   // INT
    out uint pScriptTags,   // DWORD* out
    out int pcTags   // INT* out
);

<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptGetFontScriptTags(
    hdc As IntPtr,   ' HDC optional
    psc As IntPtr,   ' void** in/out
    psa As IntPtr,   ' SCRIPT_ANALYSIS* optional
    cMaxTags As Integer,   ' INT
    <Out> ByRef pScriptTags As UInteger,   ' DWORD* out
    <Out> ByRef pcTags As Integer   ' INT* out
) As Integer
End Function

' hdc : HDC optional
' psc : void** in/out
' psa : SCRIPT_ANALYSIS* optional
' cMaxTags : INT
' pScriptTags : DWORD* out
' pcTags : INT* out
Declare PtrSafe Function ScriptGetFontScriptTags Lib "usp10" ( _
    ByVal hdc As LongPtr, _
    ByVal psc As LongPtr, _
    ByVal psa As LongPtr, _
    ByVal cMaxTags As Long, _
    ByRef pScriptTags As Long, _
    ByRef pcTags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScriptGetFontScriptTags = ctypes.windll.usp10.ScriptGetFontScriptTags
ScriptGetFontScriptTags.restype = ctypes.c_int
ScriptGetFontScriptTags.argtypes = [
    wintypes.HANDLE,  # hdc : HDC optional
    ctypes.c_void_p,  # psc : void** in/out
    ctypes.c_void_p,  # psa : SCRIPT_ANALYSIS* optional
    ctypes.c_int,  # cMaxTags : INT
    ctypes.POINTER(wintypes.DWORD),  # pScriptTags : DWORD* out
    ctypes.POINTER(ctypes.c_int),  # pcTags : INT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USP10.dll')
ScriptGetFontScriptTags = Fiddle::Function.new(
  lib['ScriptGetFontScriptTags'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC optional
    Fiddle::TYPE_VOIDP,  # psc : void** in/out
    Fiddle::TYPE_VOIDP,  # psa : SCRIPT_ANALYSIS* optional
    Fiddle::TYPE_INT,  # cMaxTags : INT
    Fiddle::TYPE_VOIDP,  # pScriptTags : DWORD* out
    Fiddle::TYPE_VOIDP,  # pcTags : INT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "usp10")]
extern "system" {
    fn ScriptGetFontScriptTags(
        hdc: *mut core::ffi::c_void,  // HDC optional
        psc: *mut *mut (),  // void** in/out
        psa: *mut SCRIPT_ANALYSIS,  // SCRIPT_ANALYSIS* optional
        cMaxTags: i32,  // INT
        pScriptTags: *mut u32,  // DWORD* out
        pcTags: *mut i32  // INT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USP10.dll")]
public static extern int ScriptGetFontScriptTags(IntPtr hdc, IntPtr psc, IntPtr psa, int cMaxTags, out uint pScriptTags, out int pcTags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USP10_ScriptGetFontScriptTags' -Namespace Win32 -PassThru
# $api::ScriptGetFontScriptTags(hdc, psc, psa, cMaxTags, pScriptTags, pcTags)

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

出力引数:

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