VB.NET Requires Chilkat v11.0.0+

SFTP Read Directory Listing

See more SFTP Examples

Demonstrates how to download a directory listing and iterate over the files. VB.NET

Dim success As Boolean = False

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

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

Dim sftp As New Chilkat.SFtp

'  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 hostname As String = "www.my-sftp-server.com"
Dim port As Integer = 22
success = sftp.Connect(hostname,port)
If (success = False) Then
    Debug.WriteLine(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 = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


'  After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
If (success = False) Then
    Debug.WriteLine(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 = sftp.OpenDir(".")
If (sftp.LastMethodSuccess = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


'  Download the directory listing:

Dim dirListing As New Chilkat.SFtpDir
success = sftp.ReadDirListing(handle,dirListing)
If (success = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


'  Close the handle for the directory listing.
success = sftp.CloseHandle(handle)
If (success = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


'  Iterate over the files.
Dim fileObj As New Chilkat.SFtpFile
Dim i As Integer = 0
Dim n As Integer = dirListing.NumFilesAndDirs
While i < n

    success = dirListing.FileAt(i,fileObj)
    If (success = False) Then
        Debug.WriteLine(dirListing.LastErrorText)
        Exit Sub
    End If


    Debug.WriteLine(fileObj.Filename)
    Debug.WriteLine(fileObj.FileType)
    Debug.WriteLine("Size in bytes: " & fileObj.Size32)
    Debug.WriteLine("----")

    i = i + 1
End While

Debug.WriteLine("Success.")