VBScript

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 VBScript Downloads

Download Chilkat for VBScript

VBScript

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

success = 0

set ftp = CreateObject("Chilkat.Ftp2")

ftp.Hostname = "ftp.example.com"
ftp.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.
ftp.Password = "myPassword"

success = ftp.Connect()
If (success = 0) Then
    outFile.WriteLine(ftp.LastErrorText)
    WScript.Quit
End If

'  AutoGetSizeForProgress sends a SIZE command before a download so percentage-based progress can
'  be computed.
ftp.AutoGetSizeForProgress = 1

'  PercentDoneScale sets the value representing one hundred percent in PercentDone callbacks.
'  1000 gives tenth-of-a-percent resolution.
ftp.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.
ftp.ProgressMonSize = 20485760

success = ftp.GetFile("public_html/bigfile.zip","qa_output/bigfile.zip")
If (success = 0) Then
    outFile.WriteLine(ftp.LastErrorText)
    WScript.Quit
End If

'  After a transfer, the current byte counts are available as 32-bit numbers or as strings (the
'  string forms avoid integer-size limits).
outFile.WriteLine("Bytes received: " & ftp.CurBytesReceived)
outFile.WriteLine("Bytes received (str): " & ftp.CurBytesReceivedStr)
outFile.WriteLine("Bytes sent: " & ftp.CurBytesSent)
outFile.WriteLine("Bytes sent (str): " & ftp.CurBytesSentStr)

success = ftp.Disconnect()
If (success = 0) Then
    outFile.WriteLine(ftp.LastErrorText)
    WScript.Quit
End If


outFile.Close