OFTPConnectionReadyToSend Property

Specifies whether or not the server can send to the client.

Syntax

 oftpserver.getOFTPConnectionReadyToSend(index, [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 getOFTPConnectionReadyToSend([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 setOFTPConnectionReadyToSend([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 whether or not the server can send to the client.

When the client passes control to the server, this property will be true. Additionally the ReadyToSend event will fire at this time. This must be true before sending files to the client.

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 read-only and not available at design time.

Data Type

Boolean