IDWriteLocalizedStrings::GetString Method

Copies the string with the specified index to the specified array.

Syntax

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

Parameter

• index
  The zero-based index of the language/string pair to be examined.

• stringBuffer [out]
  The null terminated array of characters that receives the string from the language/string pair. The buffer allocated for this array should be at least the size of size. GetStringLength can be used to get the size of the array before using this method.

• size
  The size of the array in characters. The size must include space for the terminating null character. GetStringLength can be used to get the size of the array before using this method.

Rückgabewert

Ist Methode erfolgreich, wird "S_OK" zurückgegeben. Andernfalls wird ein HRESULT-Fehlercode zurückgegeben.

Hinweise

The string returned must be allocated by the caller. You can get the size of the string by using the GetStringLength method prior to calling GetString, as shown in the following example.

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

Siehe auch

IDWriteLocalizedStrings