Delphi DLL
Delphi DLL
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 Delphi DLL Downloads
var
success: Boolean;
ftp: HCkFtp2;
begin
success := False;
ftp := CkFtp2_Create();
CkFtp2_putHostname(ftp,'ftp.example.com');
CkFtp2_putUsername(ftp,'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.
CkFtp2_putPassword(ftp,'myPassword');
success := CkFtp2_Connect(ftp);
if (success = False) then
begin
Memo1.Lines.Add(CkFtp2__lastErrorText(ftp));
Exit;
end;
// AutoGetSizeForProgress sends a SIZE command before a download so percentage-based progress can
// be computed.
CkFtp2_putAutoGetSizeForProgress(ftp,True);
// PercentDoneScale sets the value representing one hundred percent in PercentDone callbacks.
// 1000 gives tenth-of-a-percent resolution.
CkFtp2_putPercentDoneScale(ftp,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.
CkFtp2_putProgressMonSize(ftp,20485760);
success := CkFtp2_GetFile(ftp,'public_html/bigfile.zip','qa_output/bigfile.zip');
if (success = False) then
begin
Memo1.Lines.Add(CkFtp2__lastErrorText(ftp));
Exit;
end;
// After a transfer, the current byte counts are available as 32-bit numbers or as strings (the
// string forms avoid integer-size limits).
Memo1.Lines.Add('Bytes received: ' + IntToStr(CkFtp2_getCurBytesReceived(ftp)));
Memo1.Lines.Add('Bytes received (str): ' + CkFtp2__curBytesReceivedStr(ftp));
Memo1.Lines.Add('Bytes sent: ' + IntToStr(CkFtp2_getCurBytesSent(ftp)));
Memo1.Lines.Add('Bytes sent (str): ' + CkFtp2__curBytesSentStr(ftp));
success := CkFtp2_Disconnect(ftp);
if (success = False) then
begin
Memo1.Lines.Add(CkFtp2__lastErrorText(ftp));
Exit;
end;
CkFtp2_Dispose(ftp);