Win32 API 日本語リファレンス
ホームGraphics.DirectWrite › IDWriteFontCollection2

IDWriteFontCollection2

COM
IID514039c6-4617-4064-bf8b-92ea83e506e0継承元IDWriteFontCollection1自前メソッド開始 vtbl9

公式ドキュメント

このインターフェースは、システムにインストールされているフォントの集合や、特定のディレクトリ内のフォントの集合など、フォントの集合をカプセル化します。フォントコレクション API を使用すると、利用可能なフォントファミリーやフォントを検出したり、フォントに関するメタデータを取得したりできます。(IDWriteFontCollection2)

メソッド 4

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 9 HRESULT GetFontFamily(DWORD index, IDWriteFontFamily2** fontFamily)

0 から始まるフォントファミリーのインデックスを指定して、フォントファミリーオブジェクトを作成します。

indexDWORDin0 から始まるフォントファミリーのインデックス。
fontFamilyIDWriteFontFamily2**outIDWriteFontFamily2 インターフェースへのポインターのアドレス。関数が正常に完了すると、新しく作成されたフォントファミリーオブジェクトをこのポインターに設定します。

戻り値

Type: HRESULT

関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 10 HRESULT GetMatchingFonts(LPWSTR familyName, DWRITE_FONT_AXIS_VALUE* fontAxisValues, DWORD fontAxisValueCount, IDWriteFontList2** fontList)

指定したフォントファミリー内のフォントの一覧を、指定した軸の値との一致度が高い順に並べて取得します。

familyNameLPWSTRinフォントファミリーの名前。名前は大文字と小文字を区別しませんが、それ以外はコレクション内のファミリー名と完全に一致する必要があります。
fontAxisValuesDWRITE_FONT_AXIS_VALUE*inフォント軸の値の一覧を格納した配列へのポインター。配列は fontAxisValueCount 引数で示されるサイズ(要素数)である必要があります。
fontAxisValueCountDWORDinfontAxisValues 配列に含まれるフォント軸の値の数。
fontListIDWriteFontList2**outIDWriteFontList2 インターフェースへのポインターのアドレス。関数が正常に完了すると、新しく作成されたフォントリストオブジェクトをこのポインターに設定します。

戻り値

Type: HRESULT

関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

一致するフォントがない場合は、空のリストオブジェクトが返され(そのオブジェクトに対して IDWriteFontList::GetFontCount を呼び出すと 0 を返します)、関数はエラーを返しません。

vtbl 11 DWRITE_FONT_FAMILY_MODEL GetFontFamilyModel()

フォントコレクションがファミリーをグループ化する際に使用するフォントファミリーモデルを取得します。

戻り値

Type: DWRITE_FONT_FAMILY_MODEL

コレクション内でファミリーがどのようにグループ化されるか。

vtbl 12 HRESULT GetFontSet(IDWriteFontSet1** fontSet)

このコレクションが内部で使用しているフォントセットを取得します。

fontSetIDWriteFontSet1**outIDWriteFontSet1 インターフェースへのポインターのアドレス。関数が正常に完了すると、コレクションが使用しているフォントセットをこのポインターに設定します。

戻り値

Type: HRESULT

関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

出力引数:
#define global IID_IDWriteFontCollection2 "{514039C6-4617-4064-BF8B-92EA83E506E0}"
#usecom global IDWriteFontCollection2 IID_IDWriteFontCollection2 "{}"
#comfunc global IDWriteFontCollection2_GetFontFamily       9 int,sptr
#comfunc global IDWriteFontCollection2_GetMatchingFonts    10 wstr,var,int,sptr
#comfunc global IDWriteFontCollection2_GetFontFamilyModel  11
#comfunc global IDWriteFontCollection2_GetFontSet          12 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。