FileCompressionLevel Property
The compression level to use for the file.
Syntax
zip.getFileCompressionLevel(index, [callback]) zip.setFileCompressionLevel(index, fileCompressionLevel, [callback])
Default Value
4
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 getFileCompressionLevel([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 setFileCompressionLevel([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
The compression level to use for the file. This property specifies the level of compression to be used, between 0 and 6. Higher values will cause the class to compress better; lower values will cause the class to compress faster. A value of 0 will store the file without compression.
The index parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.
This property is not available at design time.
Data Type
Integer