Visual FoxPro

ProgressMonSize Property

Demonstrates the case where the ProgressMonSize property is required to monitor the progress of FTP downloads.

When a file is downloaded, most FTP servers will indicate the file size in the intermediate "150" response. For example:

RETR hamlet.xml
150 Opening BINARY mode data connection for hamlet.xml (279658 Bytes).
226 Transfer complete.

However, some FTP servers do not provide the file size. For example, from a FileZilla server:

RETR files.txt
150 Connection accepted
226 Transfer OK

If the file size is not present, the component does not know how many bytes are forthcoming, and therefore it is not possible to monitor percentage completion progress -- unless the application provides a little help by setting the ProgressMonSize property just prior to calling GetFile.

The application should set the ProgressMonSize to the size indicated by GetSizeByName as demonstrated in this example.

Visual FoxPro

LOCAL lnSuccess
LOCAL loFtp
LOCAL lcLocalFilename
LOCAL lcRemoteFilename
LOCAL lnFileSize

lnSuccess = 0

* This example requires the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

loFtp = CreateObject('Chilkat.Ftp2')
ftpEventHandler = CreateObject("ftpEvents")
EventHandler(loFtp,ftpEventHandler)

loFtp.Hostname = "ftp.example.com"
loFtp.Username = "login"
loFtp.Password = "password"

loFtp.KeepSessionLog = 1

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

* Change to the remote directory where the file is located.
* This step is only necessary if the file is not in the root directory
* for the FTP account.
lnSuccess = loFtp.ChangeRemoteDir("junk")
IF (lnSuccess <> 1) THEN
    ? loFtp.LastErrorText
    RELEASE loFtp
    CANCEL
ENDIF

* Download a file.
lcLocalFilename = "hamlet.xml"
lcRemoteFilename = "hamlet.xml"

* If the FTP server does not supply the file size in the "150"
* intermediate response (to the RETR command), then tell
* the component how many bytes are forthcoming (if your
* application wishes to monitor the progress as a percentage
* completion).
lnFileSize = loFtp.GetSizeByName(lcRemoteFilename)
loFtp.ProgressMonSize = lnFileSize

lnSuccess = loFtp.GetFile(lcRemoteFilename,lcLocalFilename)
IF (lnSuccess <> 1) THEN
    ? loFtp.LastErrorText
    RELEASE loFtp
    CANCEL
ENDIF

? loFtp.SessionLog

loFtp.Disconnect()

RELEASE loFtp

DEFINE CLASS ftpEvents AS SESSION OLEPUBLIC
IMPLEMENTS _IChilkatFtp2Events IN "Chilkat.Ftp2"

PROCEDURE _IChilkatFtp2Events_AbortCheck(abort As Number)
    * Application code goes here...

ENDPROC

PROCEDURE _IChilkatFtp2Events_BeginDownloadFile(path As String, nSkip As Number)
    * Application code goes here...
ENDPROC

PROCEDURE _IChilkatFtp2Events_BeginUploadFile(path As String, nSkip As Number)
    * Application code goes here...
ENDPROC

PROCEDURE _IChilkatFtp2Events_BinaryData(data As Variant)
    * Application code goes here...

ENDPROC

PROCEDURE _IChilkatFtp2Events_DownloadRate(byteCount As Number, bytesPerSec As Number)
    * Application code goes here...
ENDPROC

PROCEDURE _IChilkatFtp2Events_EndDownloadFile(path As String, byteCount As Number)
    * Application code goes here...
ENDPROC

PROCEDURE _IChilkatFtp2Events_EndUploadFile(path As String, byteCount As Number)
    * Application code goes here...
ENDPROC

PROCEDURE _IChilkatFtp2Events_PercentDone(pctDone As Number, abort As Number)
    * Application code goes here...
    ? "Percent Done: " + STR(pctDone)
ENDPROC

PROCEDURE _IChilkatFtp2Events_ProgressInfo(name As String, value As String)
    * Application code goes here...
    ? name + ": " + value
ENDPROC

PROCEDURE _IChilkatFtp2Events_TaskCompleted(task As Generic)
    * Application code goes here...

ENDPROC

PROCEDURE _IChilkatFtp2Events_TextData(data As String)
    * Application code goes here...

ENDPROC

PROCEDURE _IChilkatFtp2Events_UploadRate(byteCount As Number, bytesPerSec As Number)
    * Application code goes here...
ENDPROC

PROCEDURE _IChilkatFtp2Events_VerifyDeleteDir(path As String, nSkip As Number)
    * Application code goes here...
ENDPROC

PROCEDURE _IChilkatFtp2Events_VerifyDeleteFile(path As String, nSkip As Number)
    * Application code goes here...
ENDPROC

PROCEDURE _IChilkatFtp2Events_VerifyDownloadDir(path As String, nSkip As Number)
    * Application code goes here...
ENDPROC

PROCEDURE _IChilkatFtp2Events_VerifyUploadDir(path As String, nSkip As Number)
    * Application code goes here...
ENDPROC


ENDDEFINE