Delphi ActiveX

Upload to an SFTP Server Using an Open Handle

Demonstrates the Chilkat SFtp.UploadFile method, which streams a local file to a remote file identified by an open handle. The first argument is the handle (from OpenFile) and the second is the local file path. Close the handle with CloseHandle when done.

Note: This example uses relative local paths, which are resolved against the application's current working directory. Absolute local paths may also be used. Supply the paths appropriate to your own environment.

Background: This is the lower-level upload, useful when you need control that UploadFileByName does not offer — for example choosing the exact create disposition (create-new versus truncate versus append) via OpenFile, or reusing a handle across operations. The transfer itself is streamed and unbounded by memory. The trade-off is that you own the handle's lifetime and must close it explicitly.

Chilkat Delphi ActiveX Downloads

Download Chilkat for Delphi ActiveX

Delphi ActiveX

var
success: Integer;
sftp: TChilkatSFtp;
port: Integer;
password: WideString;
handle: WideString;

begin
success := 0;

//  Demonstrates the SFtp.UploadFile method, which streams a local file to a remote file that is
//  identified by an open handle.  The 1st argument is the handle and the 2nd is the local file
//  path.

sftp := TChilkatSFtp.Create(Self);

//  Connect, authenticate, and initialize the SFTP subsystem.
port := 22;
success := sftp.Connect('sftp.example.com',port);
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

//  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.
password := 'mySshPassword';

success := sftp.AuthenticatePw('mySshLogin',password);
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

success := sftp.InitializeSftp();
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

//  Open (creating/truncating) the remote file for writing.  OpenFile returns a handle string.
handle := sftp.OpenFile('subdir/report.pdf','writeOnly','createTruncate');
if (sftp.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

//  Stream the local file to the open remote handle.  The transfer is not limited by memory.
success := sftp.UploadFile(handle,'qa_data/report.pdf');
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

//  Close the remote handle when the upload is complete.
success := sftp.CloseHandle(handle);
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;
Memo1.Lines.Add('Uploaded.');

sftp.Disconnect();