Download Method

Download a RemoteFile from an SCP server.

Syntax

scp.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 an absolute or relative path on the server.

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

Example

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

SCPControl.Localfile = "C:\localfile2.txt"
SCPControl.RemoteFile = "folder/remotefile2.txt"
SCPControl.Upload()

Multiple file uploads and downloads are supported through the use of filemasks.

To upload files matching a filemask set LocalFile to a local path including a filemask. Set RemotePath to the directory on the server where the files will be uploaded. In this case RemoteFile is ignored. All matching files will be upload when Upload is called. The StartTransfer, Transfer, and EndTransfer events provide details about the individual file transfers.

To download files matching a filemask set RemoteFile to a filemask. The path may be specified as part of the value in RemoteFile or may be set separately in RemotePath. LocalFile should be set to a local directory where files will be downloaded. When Download is called all matching files are downloaded. The StartTransfer, Transfer, and EndTransfer events provide details about the individual file transfers. In the event an individual file fails to transfer the Error event will fire.