Delphi ActiveX

Open a Remote Directory on an SFTP Server

Demonstrates the Chilkat SFtp.OpenDir method, which opens a remote directory and returns a handle for reading its entries. The only argument is the directory path. Close the handle with CloseHandle when finished.

Background: Listing a directory in SFTP is a handle-based operation, mirroring file access: open the directory to get a handle, read its entries, then close it. The handle is passed to ReadDirListing to retrieve the names and attributes. As with file handles, the directory handle is a server-side resource that should be closed to avoid exhausting the server's limits.

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.OpenDir method, which opens a remote directory and returns a handle for
//  reading its entries.  The only argument is the directory 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 the remote directory.  OpenDir returns a handle string.
handle := sftp.OpenDir('subdir');
if (sftp.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;
Memo1.Lines.Add('Opened directory, handle = ' + handle);

//  The directory entries are read with ReadDirListing using this handle.

//  Close the handle when finished.
success := sftp.CloseHandle(handle);
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

sftp.Disconnect();