DefaultFileCompression Property
The default compression mode to use when creating files and alternate streams.
Syntax
cbmemdrive.getDefaultFileCompression([callback]) cbmemdrive.setDefaultFileCompression( defaultFileCompression, [callback])
Default Value
0
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 the getDefaultFileCompression([callback]) 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.
The callback for the setDefaultFileCompression([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
This property specifies the default compression mode that the class should use when creating files and alternate streams. Valid values are:
| CBFSSTORAGE_CM_NONE | 0 | Don't use compression. |
| CBFSSTORAGE_CM_DEFAULT | 1 | Use default compression (zlib). |
| CBFSSTORAGE_CM_CUSTOM | 2 | Use event-based custom compression.
Compression level is not used. |
| CBFSSTORAGE_CM_ZLIB | 3 | Use zlib compression.
Valid compression levels are 1-9. |
| CBFSSTORAGE_CM_RLE | 4 | Use RLE compression.
Compression level is not used. |
Applications that use custom compression must the DataCompress and DataDecompress events. Please refer to the Compression topic for more information.
Applications can also specify a default compression level using the DefaultFileCompressionLevel configuration setting, if desired.
Data Type
Integer