(Lianja) SFTP Read Directory Listing

See more SFTP Examples

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

// 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 <> .T.) 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 <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

// After authenticating, the SFTP subsystem must be initialized:
llSuccess = loSftp.InitializeSftp()
if (llSuccess <> .T.) 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 <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

// Download the directory listing:
loDirListing = loSftp.ReadDir(lcHandle)
if (loSftp.LastMethodSuccess <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

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

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

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

    release loFileObj

    i = i + 1
enddo

release loDirListing

? "Success."


release loSftp