(Xojo Plugin) SFTP Sync Download Tree w/ Must-Match Directory Constraints

Demonstrates how SFTP synchronize a directory tree in the download direction, but only entering directories matching a set of wildcard filenames.

Note: This example requires Chilkat v9.5.0.76 or greater.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

Dim sftp As New Chilkat.SFtp

Dim success As Boolean
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

// Possible synchronization modes 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.

// Only enter remote directories named either "data" or matching "x*"
sftp.SyncMustMatchDir = "data; x*"

// Imagine our remote directory tree has these files and directories:

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

Dim remoteDir As String
remoteDir = "syncDownloadTest/someDir"
Dim localDir As String
localDir = "qa_output"
Dim mode As Int32
mode = 0
Dim recursive As Boolean
recursive = True
success = sftp.SyncTreeDownload(remoteDir,localDir,mode,recursive)
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// The following files were downloaded:

// accentedLatin1.txt
// accentedUtf8.txt
// alice.key
// anter_cert.pem
// chiliPepper.gif
// helloWorld.pdf
// data/chiliPepper.gif
// data/xyz/dkimHtmlBody.txt
// data/xyz/dkimVerifyTest.eml
// data/xyz/emailForCreateDsn.eml

System.DebugLog("Success.")