DataCompress Event

Fires to compress a block of data using a custom compression algorithm.

Syntax

class CBDriveDataCompressEventParams {
public:
  const void *InData();
  int InSize();
  void *OutData();
  int OutSize();
  void SetOutSize(int iOutSize);
  int CompressionLevel();
  int ResultCode();
  void SetResultCode(int iResultCode);
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void DataCompress(CBDriveDataCompressEventParams *e);
// Or, subclass CBDrive and override this emitter function. virtual int FireDataCompress(CBDriveDataCompressEventParams *e) {...}

Remarks

This event fires when the class needs to compress a block of data using an application-defined compression algorithm. Please refer to the Compression topic for more information.

This event only needs to be handled by applications that use the CBFSSTORAGE_CM_CUSTOM compression mode. To handle this event properly, applications must compress all InSize bytes of data in the InData buffer, write the compressed data to the OutData buffer, and set OutSize to reflect the total number of bytes written to OutData.

Note that OutSize is initially set to the capacity of the OutData buffer. If the OutData buffer is not large enough to accommodate all of the data after compression (which, while uncommon, may occur with some compression algorithms), do not write any data to OutData. Instead, set ResultCode to CBFSSTORAGE_ERR_BUFFER_TOO_SMALL to inform the class that the current block of data should remain uncompressed.

Please refer to the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The CompressionLevel specifies the requested compression level. Possible values are 0 through 9; where 0 means "use the default compression level". Applications may ignore this value if it is not needed by their compression algorithm.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), set it to a non-zero value to report an appropriate error. Please refer to the Error Reporting and Handling topic for more information.

 
 
Copyright (c) 2020 Callback Technologies, Inc. - All rights reserved.
CBFS Storage 2020 Qt Edition - Version 20.0 [Build 7649]