Xojo Plugin

SFTP Download all Files in a Directory

See more SFTP Examples

Demonstrates how to download all files in a remote directory. This example uses the SyncTreeDownload method in a non-recursive mode that forces the download of all files, regardless of date/time or size differences. Xojo Plugin

Dim success As Boolean
success = False

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim sftp As New Chilkat.SFtp

success = sftp.Connect("my-ssh-server.com",22)
If (success = True) Then
    success = sftp.AuthenticatePw("mySshLogin","mySshPassword")
End If

If (success = True) Then
    success = sftp.InitializeSftp()
End If

If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// Download all the files from the remote directory "syncDownloadTest/xml"
// into our local directory "qa_output"
// Both directories are relative paths.  The remote directory
// is relative to the HOME directory of the SSH user account.
// The local directory is relative to the current working directory of the process.
// It is also possible to use absolute paths.

Dim remoteDir As String
remoteDir = "syncDownloadTest/xml"
Dim localDir As String
localDir = "qa_output"
// Mode 0 causes SyncTreeDownload to download all files.
Dim mode As Int32
mode = 0
// Do not recursively descend the remote directory tree.  Just download all the files in specified directory.
Dim recursive As Boolean
recursive = False
success = sftp.SyncTreeDownload(remoteDir,localDir,mode,recursive)
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

System.DebugLog("Success.")