Delphi DLL

Remove a Remote Directory on an SFTP Server

Demonstrates the Chilkat SFtp.RemoveDir method, which deletes a remote directory. The only argument is the directory path.

Background: Most SFTP servers refuse to remove a directory that is not empty, so deleting a populated tree means removing its files and subdirectories first — the inverse of building a path level by level. There is no single "recursive delete" in the SFTP protocol; a client implements it by listing, descending, and removing bottom-up.

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.RemoveDir method, which deletes a remote directory.  The only argument
//  is the directory path.

sftp := CkSFtp_Create();

//  Connect, authenticate, and initialize the SFTP subsystem.
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;

success := CkSFtp_InitializeSftp(sftp);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

//  Delete a remote directory.  Most SFTP servers require the directory to be empty first.
success := CkSFtp_RemoveDir(sftp,'subdir/oldfolder');
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;
Memo1.Lines.Add('Directory removed.');

CkSFtp_Disconnect(sftp);

CkSFtp_Dispose(sftp);