(Xojo Plugin) SFTP Read Directory Listing

See more SFTP Examples

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

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

// 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
hostname = "www.my-sftp-server.com"
Dim port As Int32
port = 22
Dim success As Boolean
success = sftp.Connect(hostname,port)
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
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
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
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
handle = sftp.OpenDir(".")
If (sftp.LastMethodSuccess <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// Download the directory listing:
Dim dirListing As Chilkat.SFtpDir
dirListing = sftp.ReadDir(handle)
If (sftp.LastMethodSuccess <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// Close the handle for the directory listing.
success = sftp.CloseHandle(handle)
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// Iterate over the files.
Dim i As Int32
i = 0
Dim n As Int32
n = dirListing.NumFilesAndDirs
While i < n
    Dim fileObj As Chilkat.SFtpFile
    fileObj = dirListing.GetFileObject(i)

    System.DebugLog(fileObj.Filename)
    System.DebugLog(fileObj.FileType)
    System.DebugLog("Size in bytes: " + Str(fileObj.Size32))
    System.DebugLog("----")

    i = i + 1
Wend

System.DebugLog("Success.")