C++ Syntax

void

MKI_FileReadString(

LPWSTR f_pszValue,

const size_t f_unMaxSize );

template <size_t f_unSize> __forceinline void

MKI_FileReadString(

char (&f_rDestin)[f_unSize] );

Tries to read a quoted string from the read cache in UTF-8 format and converts it to a UTF-16 string.

Parameters

Value

[LPWSTR] Address of a text buffer to receive the string read from the file. The string will be decoded before being copied to this buffer, i.e. it will no longer contain escape sequences.

MaxSize

[const size_t] Size of the text buffer, i.e. maximum number of UTF-16 characters to read plus one.

Return Value

None, but if a read error occurs, the return value of MKI_FileReadError will be set to true. Once a read error occurred, all further calls to any read procedure will be ignored (i.e. return false).

Comment

This procedure relies on a high-performance read cache previously established by either MKI_FileReadInitDisk, MKI_FileReadInitDiskOffset or MKI_FileReadInitMemory. As a result, it will fail if this cache is currently not activated!

The behavior of this procedure depends on the settings of MKI_FileReadDelimiters!