C++ Syntax

bool

MKI_FileCheckUTF8(

HANDLE f_hFileHandle );

Checks whether a file opened for read access contains the UTF8 BOM (0xef 0xbb 0xbf). If so, those three bytes will be skipped.

Parameters

FileHandle

[HANDLE] File handle of a file open for read access.

Return Value

Returns true if the next 3 bytes of the file contain the UTF8 BOM byte sequence (0xef 0xbb 0xbf) and skips those three bytes. Otherwise, false is returned and the file pointer will be reset to the file's beginning.

Comment

Should be called immediately after opening a file for reading, e.g. using MKI_FileOpen.