Lianja
Lianja
Monitor FTP Transfer Progress
See more FTP Examples
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 Lianja Downloads
llSuccess = .F.
loFtp = createobject("CkFtp2")
loFtp.Hostname = "ftp.example.com"
loFtp.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.
loFtp.Password = "myPassword"
llSuccess = loFtp.Connect()
if (llSuccess = .F.) then
? loFtp.LastErrorText
release loFtp
return
endif
// AutoGetSizeForProgress sends a SIZE command before a download so percentage-based progress can
// be computed.
loFtp.AutoGetSizeForProgress = .T.
// PercentDoneScale sets the value representing one hundred percent in PercentDone callbacks.
// 1000 gives tenth-of-a-percent resolution.
loFtp.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.
loFtp.ProgressMonSize = 20485760
llSuccess = loFtp.GetFile("public_html/bigfile.zip","qa_output/bigfile.zip")
if (llSuccess = .F.) then
? loFtp.LastErrorText
release loFtp
return
endif
// After a transfer, the current byte counts are available as 32-bit numbers or as strings (the
// string forms avoid integer-size limits).
? "Bytes received: " + str(loFtp.CurBytesReceived)
? "Bytes received (str): " + loFtp.CurBytesReceivedStr
? "Bytes sent: " + str(loFtp.CurBytesSent)
? "Bytes sent (str): " + loFtp.CurBytesSentStr
llSuccess = loFtp.Disconnect()
if (llSuccess = .F.) then
? loFtp.LastErrorText
release loFtp
return
endif
release loFtp