(VB.NET) SFTP SyncTreeDownload - Find out what files were downloaded

See more SFTP Examples

Demonstrates how to find out which files were downloaded in a SyncTreeDownload method call.

Chilkat .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

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

Dim sftp As New Chilkat.SFtp

Dim success As Boolean = 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
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


' Synchronize the remote directory tree rooted at "syncDownloadTest/xml"
' with the local directory tree rooted at "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 = "syncDownloadTest"
Dim localDir As String = "qa_output"

' Possible modes that can be passed to the SyncTreeDownload method are:
' mode=0: Download all files
' mode=1: Download all files that do not exist on the local filesystem.
' mode=2: Download newer or non-existant files.
' mode=3: Download only newer files. If a file does not already exist on the local filesystem, it is not downloaded from the server.
' mode=5: Download only missing files or files with size differences.
' mode=6: Same as mode 5, but also download newer files.
' mode=99: Do not download files, but instead delete remote files that do not exist locally.

' This example will use mode 6 to download missing, newer, or files with size differences.
Dim mode As Integer = 6
' This example will turn on recursion to synchronize the entire tree. 
' Recursion can be turned off to synchronize the files of a single directory.
Dim recursive As Boolean = True
success = sftp.SyncTreeDownload(remoteDir,localDir,mode,recursive)
If (success <> True) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


' Examine the list of downloaded files.
' The downloaded files are listed one per line in the SyncedFiles property.
' Local directories that were created will be listed with a trailing "/" char.
Dim fileList As String = sftp.SyncedFiles
Debug.WriteLine(fileList)
Debug.WriteLine("")

' For example:

' data/
' chiliPepper.gif
' helloWorld.pdf
' alice.key
' anter_cert.pem
' text/
' accentedLatin1.txt
' accentedUtf8.txt
' abc/
' abc/chiliPepper.gif
' abc/ghk/
' text/something/
' text/PolishEmailBody.txt
' text/frenchUtf8.txt
' text/helloWorld.txt
' data/chiliPepper.gif
' data/xyz/
' data/xyz/dkimHtmlBody.txt
' data/xyz/emailForCreateDsn.eml
' data/xyz/dkimVerifyTest.eml

' You could load the strings into a Chilkat string table..
Dim sb As New Chilkat.StringBuilder
sb.Append(fileList)

Dim st As New Chilkat.StringTable
st.AppendFromSb(sb)

' Find out how many files + dirs
Debug.WriteLine("Total count = " & st.Count)

Dim i As Integer = 0
While i < st.Count
    Debug.WriteLine(st.StringAt(i))
    i = i + 1
End While


Debug.WriteLine("Success.")