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

Copia la cadena con el índice especificado en la matriz especificada.

Sintaxis

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

Parámetros

index

Tipo: UINT32

Índice de base cero del par idioma/cadena que se va a examinar.

[out] stringBuffer

Tipo: WCHAR*

Matriz terminada en null de caracteres que recibe la cadena del par idioma/cadena. El búfer asignado para esta matriz debe ser al menos el tamaño del tamaño. GetStringLength se puede usar para obtener el tamaño de la matriz antes de usar este método.

size

Tipo: UINT32

Tamaño de la matriz en caracteres. El tamaño debe incluir espacio para el carácter nulo de terminación. GetStringLength se puede usar para obtener el tamaño de la matriz antes de usar este método.

Valor devuelto

Tipo: HRESULT

Si este método se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT.

Comentarios

El autor de la llamada debe asignar la cadena devuelta. Puede obtener el tamaño de la cadena mediante el método GetStringLength antes de llamar a GetString, como se muestra en el ejemplo siguiente.

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	Value
Cliente mínimo compatible	Windows 7, Windows Vista con SP2 y Platform Update para Windows Vista [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2008 R2, Windows Server 2008 con SP2 y Actualización de plataforma para Windows Server 2008 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	dwrite.h
Library	Dwrite.lib
Archivo DLL	Dwrite.dll

Consulte también

IDWriteLocalizedStrings