IDWriteFontCollection インターフェイス (dwrite.h)

システムにインストールされているフォントのセットや、特定のディレクトリ内のフォントのセットなど、一連のフォントをカプセル化するオブジェクト。 フォント コレクション API を使用すると、使用可能なフォント ファミリとフォントを検出したり、フォントに関するいくつかのメタデータを取得したりできます。

継承

IDWriteFontCollection インターフェイスは、IUnknown インターフェイスから継承します。 IDWriteFontCollection には、次の種類のメンバーもあります。

メソッド

IDWriteFontCollection インターフェイスには、これらのメソッドがあります。

IDWriteFontCollection::FindFamilyName 指定したファミリ名を持つフォント ファミリを検索します。
IDWriteFontCollection::GetFontFamily 0 から始まるフォント ファミリ インデックスを指定して、フォント ファミリ オブジェクトを作成します。
IDWriteFontCollection::GetFontFamilyCount コレクション内のフォント ファミリの数を取得します。
IDWriteFontCollection::GetFontFromFontFace 指定したフォント面オブジェクトと同じ物理フォントに対応するフォント オブジェクトを取得します。 指定した物理フォントは、フォント コレクションに属している必要があります。

注釈

IDWriteFactory::GetSystemFontCollection メソッドは、次のコード例に示すように、システムにインストールされているフォントのセットをカプセル化する IDWriteFontCollection オブジェクトを提供します。

IDWriteFontCollection* pFontCollection = NULL;

// Get the system font collection.
if (SUCCEEDED(hr))
{
    hr = pDWriteFactory->GetSystemFontCollection(&pFontCollection);
}

IDWriteTextFormat と IDWriteTextLayout の両方に、オブジェクトで使用されているフォント コレクションを返す GetFontCollection メソッドがあります。 これらのインターフェイスでは、既定ではシステム フォント コレクションが使用されますが、代わりにカスタム フォント コレクションを使用できます。

システムで使用できるフォントを確認するには、システム フォント コレクションへの参照を取得します。 その後、 IDWriteFontCollection::GetFontFamilyCount メソッドを使用して、一覧のフォントとループの数を決定できます。 次の例では、システム フォント コレクション内のフォントを列挙し、フォント ファミリ名をコンソールに出力します。

#include <dwrite.h>
#include <string.h>
#include <stdio.h>
#include <new>

// SafeRelease inline function.
template <class T> inline void SafeRelease(T **ppT)
{
    if (*ppT)
    {
        (*ppT)->Release();
        *ppT = NULL;
    }
}

void wmain()
{
    IDWriteFactory* pDWriteFactory = NULL;

    HRESULT hr = DWriteCreateFactory(
            DWRITE_FACTORY_TYPE_SHARED,
            __uuidof(IDWriteFactory),
            reinterpret_cast<IUnknown**>(&pDWriteFactory)
            );

    IDWriteFontCollection* pFontCollection = NULL;

    // Get the system font collection.
    if (SUCCEEDED(hr))
    {
        hr = pDWriteFactory->GetSystemFontCollection(&pFontCollection);
    }

    UINT32 familyCount = 0;

    // Get the number of font families in the collection.
    if (SUCCEEDED(hr))
    {
        familyCount = pFontCollection->GetFontFamilyCount();
    }

    for (UINT32 i = 0; i < familyCount; ++i)
    {
        IDWriteFontFamily* pFontFamily = NULL;

        // Get the font family.
        if (SUCCEEDED(hr))
        {
            hr = pFontCollection->GetFontFamily(i, &pFontFamily);
        }

        IDWriteLocalizedStrings* pFamilyNames = NULL;
        
        // Get a list of localized strings for the family name.
        if (SUCCEEDED(hr))
        {
            hr = pFontFamily->GetFamilyNames(&pFamilyNames);
        }

        UINT32 index = 0;
        BOOL exists = false;
        
        wchar_t localeName[LOCALE_NAME_MAX_LENGTH];

        if (SUCCEEDED(hr))
        {
            // Get the default locale for this user.
            int defaultLocaleSuccess = GetUserDefaultLocaleName(localeName, LOCALE_NAME_MAX_LENGTH);

            // If the default locale is returned, find that locale name, otherwise use "en-us".
            if (defaultLocaleSuccess)
            {
                hr = pFamilyNames->FindLocaleName(localeName, &index, &exists);
            }
            if (SUCCEEDED(hr) && !exists) // if the above find did not find a match, retry with US English
            {
                hr = pFamilyNames->FindLocaleName(L"en-us", &index, &exists);
            }
        }
        
        // If the specified locale doesn't exist, select the first on the list.
        if (!exists)
            index = 0;

        UINT32 length = 0;

        // Get the string length.
        if (SUCCEEDED(hr))
        {
            hr = pFamilyNames->GetStringLength(index, &length);
        }

        // Allocate a string big enough to hold the name.
        wchar_t* name = new (std::nothrow) wchar_t[length+1];
        if (name == NULL)
        {
            hr = E_OUTOFMEMORY;
        }

        // Get the family name.
        if (SUCCEEDED(hr))
        {
            hr = pFamilyNames->GetString(index, name, length+1);
        }
        if (SUCCEEDED(hr))
        {
            // Print out the family name.
            wprintf(L"%s\n", name);
        }

        SafeRelease(&pFontFamily);
        SafeRelease(&pFamilyNames);

        delete [] name;
    }

    SafeRelease(&pFontCollection);
    SafeRelease(&pDWriteFactory);
}

要件

要件	値
サポートされている最小のクライアント	Windows 7、Windows Vista SP2 と Windows Vista 用プラットフォーム更新プログラム [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー	Windows Server 2008 R2、Windows Server 2008 SP2 および Windows Server 2008 用プラットフォーム更新プログラム [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	dwrite.h