Compress Property
Whether or not to compress the outgoing file.
Syntax
oftpclient.getCompress([callback]) oftpclient.setCompress( compress, [callback])
Default Value
FALSE
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 getCompress([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 setCompress([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
When sending a file to the trading partner, set this to true for the class to compress the file before sending. The file will first be compressed to a temporary file before being sent.
Note that this is only applicable when Version 2.0 of the protocol is used as indicated by Version.
This property is not available at design time.
Data Type
Boolean