VirtualFileSecurityLevel Property

The level of security for the file.

Syntax

 oftpclient.getVirtualFileSecurityLevel([callback])
 oftpclient.setVirtualFileSecurityLevel( virtualFileSecurityLevel, [callback])

Possible Values

  0 (slNone), 
  1 (slEncrypted), 
  2 (slSigned), 
  3 (slEncryptedAndSigned)

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 getVirtualFileSecurityLevel([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 setVirtualFileSecurityLevel([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 files, set this value to the level of security for the next virtual file to send. After receiving a file, this will be set to the level of security of the last file received.

When encrypting a file, RecipientCert must be set, and when signing a file, the Certificate must be set.

The file will be processed to a temporary file before being sent.

This is only valid for version 2.0 of the protocol.

This property is not available at design time.

Data Type

Integer