OFTPConnectionVirtualFileSecurityLevel Property

Specifies security options for the outgoing or incoming file.

Syntax

 oftpserver.getOFTPConnectionVirtualFileSecurityLevel(index, [callback])
 oftpserver.setOFTPConnectionVirtualFileSecurityLevel(index,  OFTPConnectionVirtualFileSecurityLevel, [callback])

Possible Values

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

Default Value

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 getOFTPConnectionVirtualFileSecurityLevel([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 setOFTPConnectionVirtualFileSecurityLevel([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

Specifies security options for the outgoing or incoming file.

When receiving files, query this property to determine the security level of the file received from the client.

When sending files to the client, this property will be used to determine what security options apply to the outgoing file. Possible values are:


0 (slNone - default)	The file will not be signed nor encrypted.
1 (slEncrypted)	The file will be encrypted using the certificate specified by the OFTPConnectionRecipientCertSubject. property
2 (slSigned)	The file will be signed using the certificate specified by the Certificate property;
3 (slEncryptedAndSigned)	The file will be both signed and encrypted.

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by OFTPConnectionVersion.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer