RestartAt Property

The offset to restart the file transfer from.

Syntax

 ftpclient.getRestartAt([callback])
 ftpclient.setRestartAt( restartAt, [callback])

Default Value

-1

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 getRestartAt([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 setRestartAt([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

If non-zero, tells the component to restart the file transfer operation at the specified position, rather than transfer the file in full.

Data Type

Long64