download Method

Download a RemoteFile from an SFTP server.

Syntax

def download() -> None: ...

Remarks

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

If there is no SSH session in place, one is automatically created by the component 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()