Delphi DLL

Disconnect from an SFTP Server

Demonstrates the Chilkat SFtp.Disconnect method, which closes the current SSH/SFTP connection. It takes no arguments. All remote file and directory handles from the session become invalid and must not be reused.

Background: Disconnecting releases the SSH transport and every SFTP handle opened on it. The object itself stays reusable, but a later session must repeat the full setup — Connect, authenticate, then InitializeSftp — because the SFTP subsystem does not survive a disconnect.

Chilkat Delphi DLL Downloads

Download Chilkat for Delphi DLL

Delphi DLL

var
success: Boolean;
sftp: HCkSFtp;
port: Integer;
password: PWideChar;

begin
success := False;

//  Demonstrates the SFtp.Disconnect method, which closes the current SSH/SFTP connection.  It
//  takes no arguments.  All remote file and directory handles from the session become invalid.

sftp := CkSFtp_Create();

//  Step 1: Connect the SSH transport.  Port 22 is the usual port.
port := 22;
success := CkSFtp_Connect(sftp,'sftp.example.com',port);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    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 := CkSFtp_AuthenticatePw(sftp,'mySshLogin',password);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

//  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
//  file or directory operations.
success := CkSFtp_InitializeSftp(sftp);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

//  ... perform SFTP operations ...

//  Close the connection.  The object remains reusable: a later session must Connect,
//  authenticate, and InitializeSftp again.
CkSFtp_Disconnect(sftp);

CkSFtp_Dispose(sftp);