SecureBlackbox Lite 2020 Node.js Edition

Questions / Feedback?

SSHSettingsCompressionLevel Property

Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression).

Syntax

 sftpclient.getSSHSettingsCompressionLevel([callback])
 sftpclient.setSSHSettingsCompressionLevel( SSHSettingsCompressionLevel, [callback])

Default Value

6

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 getSSHSettingsCompressionLevel([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 setSSHSettingsCompressionLevel([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

Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). This setting is ignored if compression wasn't accepted.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox Lite 2020 Node.js Edition - Version 20.0 [Build 8166]