C++ Syntax

bool

MKI_FileReadInitDisk(

HANDLE f_hFileHandle,

bool f_fGenerateCRC );

Prepares reading from a disk file using an additional, high-performance read cache. This cache will automatically be used by all MKI_FileRead* procedures.

Parameters

FileHandle

[HANDLE] File handle of the file previously opened for read access.

GenerateCRC

[bool] If true, all subsequent calls to file read functions will calculate a CRC32 over the data read.

Return Value

Returns true if the cache has been established successfully, else false (indicating insufficient memory).

Comment New in Version 2019.1

This will automatically call MKI_FileCheckUTF8 to skip a possible UTF-8 BOM at the file's beginning. These three bytes will not be included in a CRC32 calculation so that the overall CRC32 remains valid even if an editor strips these three bytes.