Asynchronous FTP Download

The Chilkat FTP component supports asynchronous uploads and downloads. This examples demonstrates doing a download in a background thread. The download is started by calling AsyncGetFileStart. While the download is in progress, your program may do other tasks. You may periodically check the AsyncFinished property to determine when the transfer is finished. The example below provides the remainder of the details.

Download Chilkat FTP2 ActiveX

LOCAL loFtp
LOCAL lnSuccess
LOCAL lcLocalFilename
LOCAL lcRemoteFilename

loFtp = CreateObject('Chilkat.Ftp2')

*  Any string unlocks the component for the 1st 30-days.
lnSuccess = loFtp.UnlockComponent("Anything for 30-day trial")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loFtp.LastErrorText)
    QUIT
ENDIF

loFtp.Hostname = "www.secureftp-test.com"
loFtp.Username = "test"
loFtp.Password = "test"

*  Connect and login to the FTP server.
lnSuccess = loFtp.Connect()
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loFtp.LastErrorText)
    QUIT
ENDIF

lcLocalFilename = "hamlet.xml"

lcRemoteFilename = "hamlet.xml"

*  Begin the download in a background thread.
*  Only 1 background upload or download may be active at any time.
*  (per instance of an FTP object)
lnSuccess = loFtp.AsyncGetFileStart(lcRemoteFilename,lcLocalFilename)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loFtp.LastErrorText)
    QUIT
ENDIF

*  The application is now free to do anything else
*  while the file is downloading.
*  For this example, we'll simply sleep and periodically
*  check to see if the transfer if finished.  While checking
*  however, we'll report on the progress in both number
*  of bytes tranferred and performance in bytes/second.
DO WHILE loFtp.AsyncFinished <> 1

    ? loFtp.AsyncBytesReceived + " bytes received"
    ? loFtp.DownloadRate + " bytes per second"

    *  Sleep 1 second.
    loFtp.SleepMs(1000)
ENDDO

*  Did the download succeed?
IF (loFtp.AsyncSuccess = 1) THEN
    =MESSAGEBOX("File Downloaded!")
ELSE
    *  The error information for asynchronous ops
    *  is in AsyncLog as opposed to LastErrorText
    =MESSAGEBOX(loFtp.AsyncLog)
ENDIF

loFtp.Disconnect()