B4X

Download a File from an SFTP Server

Demonstrates the Chilkat SFtp.DownloadFileByName method, which downloads a remote file to a local path in a single call. The first argument is the remote file path and the second is the local file path.

Note: This example uses relative local paths, which are resolved against the application's current working directory. Absolute local paths may also be used. Supply the paths appropriate to your own environment.

Background: The download counterpart to UploadFileByName: it opens, streams, and closes the remote file in one call, without a memory limit on the transfer size. When PreserveDate is set, the remote file's last-modified time is applied to the local copy, which matters for incremental-sync logic that compares timestamps.

Chilkat B4X Downloads

Download Chilkat for B4X

B4X

Dim success As Boolean = False

'  Demonstrates the SFtp.DownloadFileByName method, which downloads a remote file to a local path
'  in one call.  The 1st argument is the remote file path and the 2nd is the local file path.

Dim sftp As ChilkatSFtp
sftp.Initialize("sftp")

'  Connect, authenticate, and initialize the SFTP subsystem.
Dim port As Int = 22
success = sftp.Connect("sftp.example.com", port)
If success = False Then
    Log(sftp.LastErrorText)
    Return
End If


'  Normally you would not hard-code the password in source.  You should instead obtain it
'  from an interactive prompt, environment variable, or a secrets vault.
Dim password As String = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin", password)
If success = False Then
    Log(sftp.LastErrorText)
    Return
End If


success = sftp.InitializeSftp
If success = False Then
    Log(sftp.LastErrorText)
    Return
End If


'  Download a remote file to the local filesystem.
success = sftp.DownloadFileByName("subdir/report.pdf", "qa_output/report.pdf")
If success = False Then
    Log(sftp.LastErrorText)
    Return
End If

Log("Downloaded.")

sftp.Disconnect