VBScript

SFTP Read Directory Listing

See more SFTP Examples

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

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

success = 0

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

set sftp = CreateObject("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.
hostname = "www.my-sftp-server.com"
port = 22
success = sftp.Connect(hostname,port)
If (success = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
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 = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

' After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
If (success = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
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 = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

' Download the directory listing:

set dirListing = CreateObject("Chilkat.SFtpDir")
success = sftp.ReadDirListing(handle,dirListing)
If (success = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

' Close the handle for the directory listing.
success = sftp.CloseHandle(handle)
If (success = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

' Iterate over the files.
set fileObj = CreateObject("Chilkat.SFtpFile")
i = 0
n = dirListing.NumFilesAndDirs
Do While i < n

    success = dirListing.FileAt(i,fileObj)
    If (success = 0) Then
        outFile.WriteLine(dirListing.LastErrorText)
        WScript.Quit
    End If

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

    i = i + 1
Loop

outFile.WriteLine("Success.")

outFile.Close