ホーム › Globalization › ScriptGetFontFeatureTags

ScriptGetFontFeatureTags

関数

フォントが対応するOpenType機能タグを取得する。

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

シグネチャ

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

HRESULT ScriptGetFontFeatureTags(
    HDC hdc,   // optional
    void** psc,
    SCRIPT_ANALYSIS* psa,   // optional
    DWORD tagScript,
    DWORD tagLangSys,
    INT cMaxTags,
    DWORD* pFeatureTags,
    INT* pcTags
);

パラメーター

名前	型	方向	説明
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 構造体。
cMaxTags	INT	in	pFeatureTags で指定された配列の長さ。
pFeatureTags	DWORD*	out	この関数が、定義された書記体系についてデバイスコンテキストまたはキャッシュ内のフォントがサポートするタイポグラフィ機能タグを定義する OPENTYPE_TAG 構造体の配列を取得するためのバッファーへのポインター。
pcTags	INT*	out	機能タグ配列内の要素数へのポインター。

戻り値の型: HRESULT

公式ドキュメント

OpenType 処理のために、定義された書記体系に対応するタイポグラフィ機能の一覧を取得します。一覧を構成するタイポグラフィ機能タグは、指定されたデバイスコンテキストまたはキャッシュ内のフォントから取得されます。

戻り値

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

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

解説(Remarks)

OPENTYPE_TAG 構造体は形式上は ULONG 型として宣言されていますが、実際にはスペース、A-Z、または a-z の 4 つの 8 ビット ASCII 値を格納する 4 バイト配列を含みます。たとえば、Ligature 機能の機能タグは "liga" です。

この関数は、スクリプト必須または言語必須の機能をシェイピングエンジンが制御するため、それらを非表示にします。アプリケーションは、言語必須機能に対するシェイピングエンジンの処理を制御できません。たとえば、ScriptGetFontFeatureTags は、アラビア文字スクリプトの語頭形、語中形、語末形の機能を非表示にします。

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

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

<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptGetFontFeatureTags(
    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
    cMaxTags As Integer,   ' INT
    <Out> ByRef pFeatureTags 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
' tagScript : DWORD
' tagLangSys : DWORD
' cMaxTags : INT
' pFeatureTags : DWORD* out
' pcTags : INT* out
Declare PtrSafe Function ScriptGetFontFeatureTags Lib "usp10" ( _
    ByVal hdc As LongPtr, _
    ByVal psc As LongPtr, _
    ByVal psa As LongPtr, _
    ByVal tagScript As Long, _
    ByVal tagLangSys As Long, _
    ByVal cMaxTags As Long, _
    ByRef pFeatureTags 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

ScriptGetFontFeatureTags = ctypes.windll.usp10.ScriptGetFontFeatureTags
ScriptGetFontFeatureTags.restype = ctypes.c_int
ScriptGetFontFeatureTags.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
    ctypes.c_int,  # cMaxTags : INT
    ctypes.POINTER(wintypes.DWORD),  # pFeatureTags : DWORD* out
    ctypes.POINTER(ctypes.c_int),  # pcTags : INT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USP10.dll')
ScriptGetFontFeatureTags = Fiddle::Function.new(
  lib['ScriptGetFontFeatureTags'],
  [
    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,  # cMaxTags : INT
    Fiddle::TYPE_VOIDP,  # pFeatureTags : DWORD* out
    Fiddle::TYPE_VOIDP,  # pcTags : INT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "usp10")]
extern "system" {
    fn ScriptGetFontFeatureTags(
        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
        cMaxTags: i32,  // INT
        pFeatureTags: *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 ScriptGetFontFeatureTags(IntPtr hdc, IntPtr psc, IntPtr psa, uint tagScript, uint tagLangSys, int cMaxTags, out uint pFeatureTags, out int pcTags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USP10_ScriptGetFontFeatureTags' -Namespace Win32 -PassThru
# $api::ScriptGetFontFeatureTags(hdc, psc, psa, tagScript, tagLangSys, cMaxTags, pFeatureTags, pcTags)

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

出力引数:

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