IDWriteLocalizedStrings::GetString 方法 (dwrite.h)

將具有指定索引的字串複製到指定的陣列。

語法

HRESULT GetString(
        UINT32 index,
  [out] WCHAR  *stringBuffer,
        UINT32 size
);

參數

index

類型: UINT32

要檢查之語言/字串組之以零起始的索引。

[out] stringBuffer

類型: WCHAR*

從語言/字串組接收字串的 Null 終止字元陣列。 配置給這個數位的緩衝區應該至少為 大小大小。 使用此方法之前,可以使用 GetStringLength 來取得數位的大小。

size

類型: UINT32

陣列的大小,以字元為單位。 大小必須包含終止 Null 字元的空間。 使用此方法之前,可以使用 GetStringLength 來取得數位的大小。

傳回值

類型: 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);
}

規格需求

需求
最低支援的用戶端 適用於 Windows Vista 的 Windows 7、Windows Vista SP2 和平臺更新 [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows Server 2008 R2、Windows Server 2008 SP2 和 Platform Update for Windows Server 2008 [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 dwrite.h
程式庫 Dwrite.lib
Dll Dwrite.dll

另請參閱

IDWriteLocalizedStrings