Visual FoxPro

SFTP Read Directory Listing

See more SFTP Examples

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

LOCAL lnSuccess
LOCAL loSftp
LOCAL lcHostname
LOCAL lnPort
LOCAL lcHandle
LOCAL loDirListing
LOCAL loFileObj
LOCAL i
LOCAL n

lnSuccess = 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.

loSftp = CreateObject('Chilkat.SFtp')

* 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
lnSuccess = loSftp.Connect(lcHostname,lnPort)
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
ENDIF

* Authenticate with the SSH server.  Chilkat SFTP supports
* both password-based authenication as well as public-key
* authentication.  This example uses password authenication.
lnSuccess = loSftp.AuthenticatePw("myLogin","myPassword")
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
ENDIF

* After authenticating, the SFTP subsystem must be initialized:
lnSuccess = loSftp.InitializeSftp()
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
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 = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
ENDIF

* Download the directory listing:

loDirListing = CreateObject('Chilkat.SFtpDir')
lnSuccess = loSftp.ReadDirListing(lcHandle,loDirListing)
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    RELEASE loDirListing
    CANCEL
ENDIF

* Close the handle for the directory listing.
lnSuccess = loSftp.CloseHandle(lcHandle)
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    RELEASE loDirListing
    CANCEL
ENDIF

* Iterate over the files.
loFileObj = CreateObject('Chilkat.SFtpFile')
i = 0
n = loDirListing.NumFilesAndDirs
DO WHILE i < n

    lnSuccess = loDirListing.FileAt(i,loFileObj)
    IF (lnSuccess = 0) THEN
        ? loDirListing.LastErrorText
        RELEASE loSftp
        RELEASE loDirListing
        RELEASE loFileObj
        CANCEL
    ENDIF

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

    i = i + 1
ENDDO

? "Success."

RELEASE loSftp
RELEASE loDirListing
RELEASE loFileObj