EncryptionAlgorithm Property

The encryption algorithm.

Syntax

 oftpclient.getEncryptionAlgorithm([callback])
 oftpclient.setEncryptionAlgorithm( encryptionAlgorithm, [callback])

Possible Values

  0 (encra3DES), 
  1 (encraAES)

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 getEncryptionAlgorithm([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 setEncryptionAlgorithm([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

In order to use encryption, you must set the VirtualFileSecurityLevel property. The supported algorithms for encryption are:

This property is not available at design time.

Data Type

Integer