IDWriteStringList::GetString method

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

Syntax

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

Parameters

listIndex

Type: UINT32

Zero-based index of the string.

stringBuffer [out]

Type: WCHAR*

Character array that receives the string.

stringBufferSize

Type: UINT32

Size of the array in characters. The size must include space for the terminating null character.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

See also

IDWriteStringList