(Excel) SFTP Read Directory Listing

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

Download Excel Class Modules Chilkat Excel Class Modules

' 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 Chilkat.SFtp
Set sftp = Chilkat.NewSFtp

' 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.

hostname = "www.my-sftp-server.com"

port = 22

success = sftp.Connect(hostname,port)
If (success <> True) Then
    Debug.Print 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
    Debug.Print sftp.LastErrorText
    Exit Sub
End If

' After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
If (success <> True) Then
    Debug.Print 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. 

handle = sftp.OpenDir(".")
If (sftp.LastMethodSuccess <> True) Then
    Debug.Print sftp.LastErrorText
    Exit Sub
End If

' Download the directory listing:

Set dirListing = sftp.ReadDir(handle)
If (sftp.LastMethodSuccess <> True) Then
    Debug.Print sftp.LastErrorText
    Exit Sub
End If

' Iterate over the files.

i = 0

n = dirListing.NumFilesAndDirs
Do While i < n

    Set fileObj = dirListing.GetFileObject(i)

    Debug.Print fileObj.Filename
    Debug.Print fileObj.FileType
    Debug.Print "Size in bytes: "; fileObj.Size32
    Debug.Print "----"

    i = i + 1
Loop

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

Debug.Print "Success."