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 7、带 SP2 的 Windows Vista 和适用于 Windows Vista 的平台更新 [桌面应用 |UWP 应用]
最低受支持的服务器 Windows Server 2008 R2、Windows Server 2008 SP2 和适用于 Windows Server 2008 的平台更新 [桌面应用 |UWP 应用]
目标平台 Windows
标头 dwrite.h
Library Dwrite.lib
DLL Dwrite.dll

另请参阅

IDWriteLocalizedStrings