IDWriteLocalizedStrings::GetString メソッド (dwrite.h)
指定したインデックスを持つ文字列を、指定した配列にコピーします。
構文
HRESULT GetString(
UINT32 index,
[out] WCHAR *stringBuffer,
UINT32 size
);
パラメーター
index
種類: UINT32
調べる言語と文字列のペアの 0 から始まるインデックス。
[out] stringBuffer
種類: WCHAR*
言語と文字列のペアから文字列を受け取る文字の null で終わる配列。 この配列に割り当てられるバッファーは、少なくともサイズの サイズである必要があります。 GetStringLength を使用して、このメソッドを使用する前に配列のサイズを取得できます。
size
種類: UINT32
配列のサイズ (文字単位)。 サイズには、終端の null 文字のスペースを含める必要があります。 GetStringLength を使用して、このメソッドを使用する前に配列のサイズを取得できます。
戻り値
種類: HRESULT
このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。
注釈
返される文字列は、呼び出し元によって割り当てられている必要があります。 次の例に示すように、 GetStringLength メソッドを使用して、 GetString を呼び出す前に文字列のサイズを取得できます。
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);
}
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 7、Windows Vista SP2 および Windows Vista 用プラットフォーム更新プログラム [デスクトップ アプリ |UWP アプリ] |
サポートされている最小のサーバー | Windows Server 2008 R2、Windows Server 2008 SP2 および Windows Server 2008 用プラットフォーム更新プログラム [デスクトップ アプリ |UWP アプリ] |
対象プラットフォーム | Windows |
ヘッダー | dwrite.h |
Library | Dwrite.lib |
[DLL] | Dwrite.dll |