IDWriteLocalizedStrings::GetString-Methode (dwrite.h)

Kopiert die Zeichenfolge mit dem angegebenen Index in das angegebene Array.

Syntax

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

Parameter

index

Typ: UINT32

Der nullbasierte Index des zu untersuchenden Sprach-Zeichenfolgenpaars.

[out] stringBuffer

Typ: WCHAR*

Das null-beendete Array von Zeichen, das die Zeichenfolge aus dem Sprach-/Zeichenfolgenpaar empfängt. Der für dieses Array zugewiesene Puffer sollte mindestens die Größe aufweisen. GetStringLength kann verwendet werden, um die Größe des Arrays abzurufen, bevor Sie diese Methode verwenden.

size

Typ: UINT32

Die Größe des Arrays in Zeichen. Die Größe muss Leerzeichen für das beendende NULL-Zeichen enthalten. GetStringLength kann verwendet werden, um die Größe des Arrays abzurufen, bevor Sie diese Methode verwenden.

Rückgabewert

Typ: HRESULT

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Die zurückgegebene Zeichenfolge muss vom Aufrufer zugeordnet werden. Sie können die Größe der Zeichenfolge mithilfe der GetStringLength-Methode abrufen, bevor Sie GetString aufrufen, wie im folgenden Beispiel gezeigt.

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

Anforderungen

Weitere Informationen

IDWriteLocalizedStrings