VBScript

List a Remote Directory on an SFTP Server

Demonstrates the Chilkat SFtp.ReadDirListing method, which reads all remaining entries from an open directory handle into an SFtpDir object. The first argument is the handle returned by OpenDir and the second is the SFtpDir that receives the listing. The example iterates the entries with NumFilesAndDirs and FileAt, reading each SFtpFile's Filename, IsDirectory, Size64, and LastModifiedTimeStr.

Background: Listing a directory is a three-part operation: OpenDir gets a handle, ReadDirListing pulls every entry into an SFtpDir in one call, and the handle is then closed. Each entry is an SFtpFile carrying that item's name, type, size, timestamps, owner, and permission flags — a single stat covering what several separate GetFile* calls would return. The entries come back in the server's own order rather than sorted; use SFtpDir.Sort if you need a particular ordering. Note that a listing normally includes the . and .. entries, which most code skips.

Chilkat VBScript Downloads

Download Chilkat for VBScript

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

'  Demonstrates the SFtp.ReadDirListing method, which reads all remaining entries from an open
'  directory handle into an SFtpDir object.  The 1st argument is the handle (from OpenDir) and
'  the 2nd is the SFtpDir that receives the listing.

set sftp = CreateObject("Chilkat.SFtp")

'  Connect, authenticate, and initialize the SFTP subsystem.
port = 22
success = sftp.Connect("sftp.example.com",port)
If (success = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

'  Normally you would not hard-code the password in source.  You should instead obtain it
'  from an interactive prompt, environment variable, or a secrets vault.
password = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
If (success = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

success = sftp.InitializeSftp()
If (success = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

'  Open the remote directory to be listed.  OpenDir returns a handle string.
handle = sftp.OpenDir("subdir")
If (sftp.LastMethodSuccess = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

'  Read all directory entries into an SFtpDir object.
set dirListing = CreateObject("Chilkat.SFtpDir")
success = sftp.ReadDirListing(handle,dirListing)
If (success = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

'  The listing has been read, so the directory handle can be closed now.
success = sftp.CloseHandle(handle)
If (success = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

'  Iterate the entries.  Entries are in server order (Chilkat does not sort the listing).
n = dirListing.NumFilesAndDirs
outFile.WriteLine("Directory contains " & n & " entries:")

set fileObj = CreateObject("Chilkat.SFtpFile")

For i = 0 To n - 1
    '  FileAt fills the SFtpFile object with the entry at the given index.
    success = dirListing.FileAt(i,fileObj)
    If (success = 0) Then
        outFile.WriteLine(dirListing.LastErrorText)
        WScript.Quit
    End If

    If (fileObj.IsDirectory) Then
        outFile.WriteLine("  [DIR]  " & fileObj.Filename)
    Else
        '  Size64 is a 64-bit size; LastModifiedTimeStr is the modification time as text.
        outFile.WriteLine("  " & fileObj.Filename & "  (" & fileObj.Size64 & " bytes, modified " & fileObj.LastModifiedTimeStr & ")")
    End If

Next

sftp.Disconnect 

outFile.Close