Método IDWriteLocalizedStrings::GetString (dwrite.h)

Copia a cadeia de caracteres com o índice especificado para a matriz especificada.

Sintaxe

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

Parâmetros

index

Tipo: UINT32

O índice baseado em zero do par linguagem/cadeia de caracteres a ser examinado.

[out] stringBuffer

Tipo: WCHAR*

A matriz terminada em nulo de caracteres que recebe a cadeia de caracteres do par de linguagem/cadeia de caracteres. O buffer alocado para essa matriz deve ter pelo menos o tamanho do tamanho. GetStringLength pode ser usado para obter o tamanho da matriz antes de usar esse método.

size

Tipo: UINT32

O tamanho da matriz em caracteres. O tamanho deve incluir espaço para o caractere nulo de terminação. GetStringLength pode ser usado para obter o tamanho da matriz antes de usar esse método.

Retornar valor

Tipo: HRESULT

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

A cadeia de caracteres retornada deve ser alocada pelo chamador. Você pode obter o tamanho da cadeia de caracteres usando o método GetStringLength antes de chamar GetString, conforme mostrado no exemplo a seguir.

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

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 7, Windows Vista com SP2 e Atualização de Plataforma para Windows Vista [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2008 R2, Windows Server 2008 com SP2 e Platform Update para Windows Server 2008 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	dwrite.h
Biblioteca	Dwrite.lib
DLL	Dwrite.dll

Confira também

IDWriteLocalizedStrings