AutoIt

Monitor FTP Transfer Progress

Demonstrates the progress properties CurBytesReceived, CurBytesReceivedStr, CurBytesSent, CurBytesSentStr, ProgressMonSize, PercentDoneScale, and AutoGetSizeForProgress.

Note: The local paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background: Percentage progress needs a known total, but FTP does not always report a file's size up front — so AutoGetSizeForProgress issues a SIZE command before a download, and ProgressMonSize supplies an expected size when even that is unavailable (a one-shot value consumed by the next transfer). PercentDoneScale sets the resolution of progress callbacks. The current byte counts are exposed both as 32-bit integers and as strings, the string forms avoiding integer-width limits for very large transfers.

Chilkat AutoIt Downloads

Download Chilkat for AutoIt

AutoIt

Local $bSuccess = False

$oFtp = ObjCreate("Chilkat.Ftp2")

$oFtp.Hostname = "ftp.example.com"
$oFtp.Username = "myFtpLogin"

;  Normally you would not hard-code the password in source.  You should instead obtain it
;  from an interactive prompt, environment variable, or a secrets vault.
$oFtp.Password = "myPassword"

$bSuccess = $oFtp.Connect()
If ($bSuccess = False) Then
    ConsoleWrite($oFtp.LastErrorText & @CRLF)
    Exit
EndIf

;  AutoGetSizeForProgress sends a SIZE command before a download so percentage-based progress can
;  be computed.
$oFtp.AutoGetSizeForProgress = True

;  PercentDoneScale sets the value representing one hundred percent in PercentDone callbacks.
;  1000 gives tenth-of-a-percent resolution.
$oFtp.PercentDoneScale = 1000

;  ProgressMonSize is a one-shot expected size for the next download when the size is not
;  otherwise known.  It is consumed by the next download and reset to 0.
$oFtp.ProgressMonSize = 20485760

$bSuccess = $oFtp.GetFile("public_html/bigfile.zip","qa_output/bigfile.zip")
If ($bSuccess = False) Then
    ConsoleWrite($oFtp.LastErrorText & @CRLF)
    Exit
EndIf

;  After a transfer, the current byte counts are available as 32-bit numbers or as strings (the
;  string forms avoid integer-size limits).
ConsoleWrite("Bytes received: " & $oFtp.CurBytesReceived & @CRLF)
ConsoleWrite("Bytes received (str): " & $oFtp.CurBytesReceivedStr & @CRLF)
ConsoleWrite("Bytes sent: " & $oFtp.CurBytesSent & @CRLF)
ConsoleWrite("Bytes sent (str): " & $oFtp.CurBytesSentStr & @CRLF)

$bSuccess = $oFtp.Disconnect()
If ($bSuccess = False) Then
    ConsoleWrite($oFtp.LastErrorText & @CRLF)
    Exit
EndIf