Download Method

Download a RemoteFile from an SFTP server.

Syntax

sftp.download([callback])

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 this 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

The remote file specified by RemoteFile is downloaded to the local file specified by LocalFile, or it is retrieved through the Transfer event, if the LocalFile property is "" (empty string). RemoteFile is either an absolute path on the server, or a path relative to RemotePath.

If there is no SSH session in place, one is automatically created by first.

Example (Download a File)

SFTPControl.Localfile = "C:\localfile.txt"
SFTPControl.RemoteFile = "remotefile.txt"
SFTPControl.Download()

SFTPControl.Localfile = "C:\localfile2.txt"
SFTPControl.RemoteFile = "folder/remotefile2.txt"
SFTPControl.Download()