SFTP Download Files Matching a Pattern

Demonstrates how to download the files in a remote SFTP directory matching a file pattern. The example opens a directory, iterates over the files, and downloads each file matching a file pattern, such as "*.xml".

Download Chilkat .NET for 4.0 Framework

Download Chilkat .NET for 64-bit 4.0 Framework (x64)

Download Chilkat .NET for 2.0 / 3.5 Framework

Download Chilkat .NET for 64-bit 2.0 / 3.5 Framework (x64)

Download Chilkat .NET for 1.0 / 1.1 Framework

'  Important: It is helpful to send the contents of the
'  sftp.LastErrorText property when requesting support.

Dim sftp As New Chilkat.SFtp()

'  Any string automatically begins a fully-functional 30-day trial.
Dim success As Boolean
success = sftp.UnlockComponent("Anything for 30-day trial")
If (success <> true) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


'  Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs = 5000
sftp.IdleTimeoutMs = 10000

'  Connect to the SSH server.
'  The standard SSH port = 22
'  The hostname may be a hostname or IP address.
Dim port As Long
Dim hostname As String
hostname = "www.my-sftp-server.com"
port = 22
success = sftp.Connect(hostname,port)
If (success <> true) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


'  Authenticate with the SSH server.  Chilkat SFTP supports
'  both password-based authenication as well as public-key
'  authentication.  This example uses password authenication.
success = sftp.AuthenticatePw("myLogin","myPassword")
If (success <> true) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


'  After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
If (success <> true) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


'  Open a directory on the server...
'  Paths starting with a slash are "absolute", and are relative
'  to the root of the file system. Names starting with any other
'  character are relative to the user's default directory (home directory).
'  A path component of ".." refers to the parent directory,
'  and "." refers to the current directory.
Dim handle As String
Dim dirPath As String
dirPath = "abc123"
handle = sftp.OpenDir(dirPath)
If (handle = vbNullString ) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


'  Download the directory listing:
Dim dirListing As Chilkat.SFtpDir
dirListing = sftp.ReadDir(handle)
If (dirListing Is Nothing ) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


'  Iterate over the files.
Dim i As Long
Dim n As Long
n = dirListing.NumFilesAndDirs
If (n = 0) Then
    TextBox1.Text = TextBox1.Text & "No entries found in this directory." & vbCrLf
Else
    For i = 0 To n - 1
        Dim fileObj As Chilkat.SFtpFile
        fileObj = dirListing.GetFileObject(i)

        TextBox1.Text = TextBox1.Text & fileObj.Filename & vbCrLf

        '  Does this filename match the desired pattern?
        '  Write code here to determine if it's a match or not.

        '  Assuming it's a match, you would download the file
        '  like this:
        Dim remoteFilePath As String
        remoteFilePath = dirPath & "/"
        remoteFilePath = remoteFilePath & fileObj.Filename
        Dim localFilePath As String
        localFilePath = fileObj.Filename
        success = sftp.DownloadFileByName(remoteFilePath,localFilePath)
        If (success <> true) Then
            MsgBox(sftp.LastErrorText)
            Exit Sub
        End If



    Next
End If




'  Close the directory
success = sftp.CloseHandle(handle)
If (success <> true) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


MsgBox("Success.")