C++ Syntax

bool

MKI_FileWriteInitDisk(

HANDLE f_hFileHandle,

bool f_fGenerateCRC,

bool f_fIsUTF8 );

Prepares writing to a disk file using an additional, high-performance write cache. This cache will automatically be used by all MKI_FileWrite* procedures.

Parameters

FileHandle

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

GenerateCRC

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

IsUTF8 New in Version 2019.1

[bool] If true, a standard UTF-8 BOM byte sequence (0xef 0xbb 0xbf) will be written to the beginning of the file. 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.

Return Value

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