C++ Syntax

void

MKI_FileReadBinary(

void* f_pValue,

const size_t f_unMaxSize );

Tries to read quoted, encoded binary data from the read cache.

Parameters

Value

[void*] Address of a buffer to receive the data read from the file. The binary data will be decoded before being copied to this buffer. If the binary string does contain less bytes than requested, the missing bytes will be set to zero.

MaxSize

[const size_t] Size of the buffer, i.e. maximum number of bytes to read.

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!