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

llSuccess = .F.

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

loSftp = createobject("CkSFtp")

//  Set some timeouts, in milliseconds:
loSftp.ConnectTimeoutMs = 5000
loSftp.IdleTimeoutMs = 10000

//  Connect to the SSH server.  
//  The standard SSH port = 22
//  The hostname may be a hostname or IP address.
lcHostname = "www.my-sftp-server.com"
lnPort = 22
llSuccess = loSftp.Connect(lcHostname,lnPort)
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

//  Authenticate with the SSH server.  Chilkat SFTP supports
//  both password-based authenication as well as public-key
//  authentication.  This example uses password authenication.
llSuccess = loSftp.AuthenticatePw("myLogin","myPassword")
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

//  After authenticating, the SFTP subsystem must be initialized:
llSuccess = loSftp.InitializeSftp()
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

//  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. 
lcHandle = loSftp.OpenDir(".")
if (loSftp.LastMethodSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

//  Download the directory listing:

loDirListing = createobject("CkSFtpDir")
llSuccess = loSftp.ReadDirListing(lcHandle,loDirListing)
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    release loDirListing
    return
endif

//  Close the handle for the directory listing.
llSuccess = loSftp.CloseHandle(lcHandle)
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    release loDirListing
    return
endif

//  Iterate over the files.
loFileObj = createobject("CkSFtpFile")
i = 0
n = loDirListing.NumFilesAndDirs
do while i < n

    llSuccess = loDirListing.FileAt(i,loFileObj)
    if (llSuccess = .F.) then
        ? loDirListing.LastErrorText
        release loSftp
        release loDirListing
        release loFileObj
        return
    endif

    ? loFileObj.Filename
    ? loFileObj.FileType
    ? "Size in bytes: " + str(loFileObj.Size32)
    ? "----"

    i = i + 1
enddo

? "Success."


release loSftp
release loDirListing
release loFileObj