ProgressMonSize Property

Download 32-bit Chilkat FTP2 ActiveX (.msi)

Download All 32-bit Chilkat ActiveX Components (.zip)

Download All 64-bit Chilkat ActiveX Components (.zip)

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.

LOCAL loFtp
LOCAL lnSuccess
LOCAL lcLocalFilename
LOCAL lcRemoteFilename
LOCAL lnFileSize

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 = "ftp.chilkatsoft.com"
loFtp.Username = "****"
loFtp.Password = "****"

loFtp.KeepSessionLog = 1

*  Connect and login to the FTP server.
lnSuccess = loFtp.Connect()
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loFtp.LastErrorText)
    QUIT
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
    =MESSAGEBOX(loFtp.LastErrorText)
    QUIT
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
    =MESSAGEBOX(loFtp.LastErrorText)
    QUIT
ENDIF

? loFtp.SessionLog

loFtp.Disconnect()