C++ Syntax

void

MKI_FileWriteComment(

const LPCSTR f_pszValue );

Writes a comment to the current write cache.

Parameters

Value

[const LPCSTR] Address of a buffer containing the null-terminated Ansi comment string to be written to the file. Only characters Ansi 32 through 255 will be written to the file!

Return Value

None, but if a write error occurs, the return value of MKI_FileWriteError will be set to true. Once a write error occurred, all further calls to any write procedure will be ignored (i.e. return false).

Comment

This procedure relies on a high-performance write cache previously established by either MKI_FileWriteInitNull, MKI_FileWriteInitDisk or MKI_FileWriteInitMemory. As a result, it will fail if this cache is currently not activated!

The behavior of this procedure depends on the settings of MKI_FileWriteDelimiters and MKI_FileWriteZeros!