AddBytesToWriteBuffer Method
Reserves extra space in the file data buffers used in file read/write events.
Syntax
cbfilter.addBytesToWriteBuffer(extraBytes, [callback])
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for this method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
'err' has 2 properties which hold detailed information:
err.code err.message
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.