SFTP Object
 
Syntax
 
SFTP.SyncMustMatch As String
 
Description
Can contain a wildcarded list of file patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the SyncTreeUpload and SyncTreeDownload methods will only transfer files that match any one of these patterns. This property only applies to files. It does not apply to sub-directory names when recursively traversing a directory tree.
 
See Also

Example
Sub Main
 
Dim success As Long
success = sftp.Connect("my-ssh-server.com",22)
If (success = 1) Then
    success = sftp.AuthenticatePw("mySshLogin","mySshPassword")
End If
 
If (success = 1) Then
    success = sftp.InitializeSftp()
End If
 
If (success <> 1) Then
    Debug.Print sftp.LastErrorText
    Exit Sub
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.
 
' This example will download all files, but only those files having filenames
' that match *.gif and *.eml
 
' 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/
 
' Indicate that we only want to create auto-create local directories (if needed)
' for the files that are actually downloaded.  If SyncCreateAllLocalDirs remains
' 1, then the corresponding local directory is created for each remote directory
' traversed regardless of whether files within are downloaded.
sftp.SyncCreateAllLocalDirs = 0
 
sftp.SyncMustMatch = "*.eml; *.gif"
 
Dim remoteDir As String
remoteDir = "syncDownloadTest/someDir"
Dim localDir As String
localDir = "qa_output"
Dim mode As Long
mode = 0
Dim recursive As Long
recursive = 1
success = sftp.SyncTreeDownload(remoteDir,localDir,mode,recursive)
If (success <> 1) Then
    Debug.Print sftp.LastErrorText
    Exit Sub
End If
 
' The following files were downloaded:
 
' chiliPepper.gif
' abc/chiliPepper.gif
' data/chiliPepper.gif
' data/xyz/dkimVerifyTest.eml
' data/xyz/emailForCreateDsn.eml
 
Debug.Print "Success."
 
End Sub