AddBytesToWriteBuffer Method

Reserves extra space in the file data buffers used in file read/write events.

Syntax

bool AddBytesToWriteBuffer(int iExtraBytes);

Remarks

Applications that plan to add additional data when files are being read and/or written should call this method to specify how much extra space to reserve in the file data buffers used in the BeforeReadFile, AfterReadFile, BeforeWriteFile, and AfterWriteFile events. If successful, this method returns true; otherwise, it returns false.

The ExtraBytes parameter specifies how many bytes to reserve. Note that the value passed for this parameter must be a multiple of 512.

Note: This method cannot be called when Active is true.

Error Handling

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.