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

load ./chilkat.dll

set 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 [new_CkSFtp]

#  Set some timeouts, in milliseconds:
CkSFtp_put_ConnectTimeoutMs $sftp 5000
CkSFtp_put_IdleTimeoutMs $sftp 10000

#  Connect to the SSH server.  
#  The standard SSH port = 22
#  The hostname may be a hostname or IP address.
set hostname "www.my-sftp-server.com"
set port 22
set success [CkSFtp_Connect $sftp $hostname $port]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

#  Authenticate with the SSH server.  Chilkat SFTP supports
#  both password-based authenication as well as public-key
#  authentication.  This example uses password authenication.
set success [CkSFtp_AuthenticatePw $sftp "myLogin" "myPassword"]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

#  After authenticating, the SFTP subsystem must be initialized:
set success [CkSFtp_InitializeSftp $sftp]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

#  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. 
set handle [CkSFtp_openDir $sftp "."]
if {[CkSFtp_get_LastMethodSuccess $sftp] == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

#  Download the directory listing:

set dirListing [new_CkSFtpDir]

set success [CkSFtp_ReadDirListing $sftp $handle $dirListing]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    delete_CkSFtpDir $dirListing
    exit
}

#  Close the handle for the directory listing.
set success [CkSFtp_CloseHandle $sftp $handle]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    delete_CkSFtpDir $dirListing
    exit
}

#  Iterate over the files.
set fileObj [new_CkSFtpFile]

set i 0
set n [CkSFtpDir_get_NumFilesAndDirs $dirListing]
while {$i < $n} {

    set success [CkSFtpDir_FileAt $dirListing $i $fileObj]
    if {$success == 0} then {
        puts [CkSFtpDir_lastErrorText $dirListing]
        delete_CkSFtp $sftp
        delete_CkSFtpDir $dirListing
        delete_CkSFtpFile $fileObj
        exit
    }

    puts [CkSFtpFile_filename $fileObj]
    puts [CkSFtpFile_fileType $fileObj]
    puts "Size in bytes: [CkSFtpFile_get_Size32 $fileObj]"
    puts "----"

    set i [expr $i + 1]
}

puts "Success."

delete_CkSFtp $sftp
delete_CkSFtpDir $dirListing
delete_CkSFtpFile $fileObj