ホーム › Globalization › ScriptGetFontLanguageTags

ScriptGetFontLanguageTags

関数

指定スクリプトでフォントが対応する言語システムタグを取得する。

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

シグネチャ

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

HRESULT ScriptGetFontLanguageTags(
    HDC hdc,   // optional
    void** psc,
    SCRIPT_ANALYSIS* psa,   // optional
    DWORD tagScript,
    INT cMaxTags,
    DWORD* pLangsysTags,
    INT* pcTags
);

パラメーター

名前	型	方向	説明
hdc	HDC	inoptional	デバイスコンテキストへのハンドル。詳細については、Caching を参照してください。
psc	void**	inout	スクリプトキャッシュを識別する SCRIPT_CACHE 構造体へのポインター。
psa	SCRIPT_ANALYSIS*	inoptional	ScriptItemizeOpenType の以前の呼び出しから取得した SCRIPT_ANALYSIS 構造体へのポインター。このパラメーターはシェーピングエンジンを識別し、適切なフォントおよびスクリプトに対応するフォント言語タグを取得できるようにします。あるいは、アプリケーションはこのパラメーターを NULL に設定して、フィルター処理されていない結果を取得することもできます。
tagScript	DWORD	in	関連付けられた言語タグの一覧を要求するスクリプトタグを定義する OPENTYPE_TAG 構造体。
cMaxTags	INT	in	pLangSysTags で指定された配列の長さ。
pLangsysTags	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 バイトの配列を含みます。たとえば、ルーマニア語、ウルドゥー語、ペルシャ語の言語タグは、それぞれ "ROM "、"URD "、"FAR " です。各タグはスペースで終わることに注意してください。

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

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

<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptGetFontLanguageTags(
    hdc As IntPtr,   ' HDC optional
    psc As IntPtr,   ' void** in/out
    psa As IntPtr,   ' SCRIPT_ANALYSIS* optional
    tagScript As UInteger,   ' DWORD
    cMaxTags As Integer,   ' INT
    <Out> ByRef pLangsysTags 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
' cMaxTags : INT
' pLangsysTags : DWORD* out
' pcTags : INT* out
Declare PtrSafe Function ScriptGetFontLanguageTags Lib "usp10" ( _
    ByVal hdc As LongPtr, _
    ByVal psc As LongPtr, _
    ByVal psa As LongPtr, _
    ByVal tagScript As Long, _
    ByVal cMaxTags As Long, _
    ByRef pLangsysTags 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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "usp10")]
extern "system" {
    fn ScriptGetFontLanguageTags(
        hdc: *mut core::ffi::c_void,  // HDC optional
        psc: *mut *mut (),  // void** in/out
        psa: *mut SCRIPT_ANALYSIS,  // SCRIPT_ANALYSIS* optional
        tagScript: u32,  // DWORD
        cMaxTags: i32,  // INT
        pLangsysTags: *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 ScriptGetFontLanguageTags(IntPtr hdc, IntPtr psc, IntPtr psa, uint tagScript, int cMaxTags, out uint pLangsysTags, out int pcTags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USP10_ScriptGetFontLanguageTags' -Namespace Win32 -PassThru
# $api::ScriptGetFontLanguageTags(hdc, psc, psa, tagScript, cMaxTags, pLangsysTags, pcTags)

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

出力引数:

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