C++ Syntax

bool

MKI_FileReadInitDiskOffset(

HANDLE f_hFileHandle,

const size_t f_unOffset )

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

Parameters

FileHandle

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

Offset

[const size_t] Position in the file where to start reading. Must be positive value!

Return Value

Returns true if the cache has been established successfully, else false (indicating insufficient memory or Offset being out of range).

Comment New in Version 2019.1

If Offset is zero, this will automatically call MKI_FileCheckUTF8 to skip a possible UTF-8 BOM at the file's beginning.