IDWriteLocalizedStrings

ロケール名でインデックス付けされた文字列のコレクションを表します。

IDWriteLocalizedStrings が表す文字列の集合は、ロケールに対応付けられる 0 から始まる UINT32 番号でインデックス付けされます。特定のロケールに対応する数値インデックスは、FindLocaleName メソッドを使用して取得します。

IDWriteLocalizedStrings インターフェースの一般的な用途は、IDWriteFontFamily::GetFamilyNames メソッドを使用して作成された、ローカライズ済みフォントファミリ名のリストを保持することです。次の例は、"en-us" ロケールのファミリ名を取得する方法を示しています。

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);
}

言語と文字列のペアの数を取得します。

型: UINT32

言語と文字列のペアの数。

指定したロケール名を持つ、ロケール名と文字列のペアの 0 から始まるインデックスを取得します。

型: HRESULT

指定したロケール名が存在しない場合、戻り値は S_OK ですが、 index は UINT_MAX、exists は FALSE になります。

ロケール名が存在しない場合でも、戻り値は成功であり、exists パラメーターが FALSE になる点に注意してください。フォントのフォントファミリ名を取得していて、指定したロケール名が存在しない場合の 1 つの方法は、次に示すようにインデックスを 0 に設定することです。フォントファミリには常に少なくとも 1 つのロケールが存在します。

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;

指定したインデックスのロケール名の長さ(null 終端文字を含まない)を文字数で取得します。(IDWriteLocalizedStrings.GetLocaleNameLength)

型: HRESULT

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

指定したインデックスのロケール名を、指定した配列にコピーします。(IDWriteLocalizedStrings.GetLocaleName)

型: HRESULT

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

指定したインデックスの文字列の長さ(null 終端文字を含まない)を文字数で取得します。(IDWriteLocalizedStrings.GetStringLength)

型: HRESULT

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

次のコードに示すように、IDWriteLocalizedStrings::GetString メソッドを呼び出す前に GetStringLength を使用して文字列の長さを取得します。

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);
}

指定したインデックスの文字列を、指定した配列にコピーします。(IDWriteLocalizedStrings.GetString)

型: HRESULT

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

返される文字列は呼び出し側で割り当てる必要があります。次の例に示すように、GetString を呼び出す前に GetStringLength メソッドを使用して文字列のサイズを取得できます。

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);
}