Delphi ActiveX Requires Chilkat v11.0.0+

SFTP Read Directory Listing

See more SFTP Examples

Demonstrates how to download a directory listing and iterate over the files. Delphi ActiveX

var
success: Integer;
sftp: TChilkatSFtp;
hostname: WideString;
port: Integer;
handle: WideString;
dirListing: TChilkatSFtpDir;
fileObj: TChilkatSFtpFile;
i: Integer;
n: Integer;

begin
success := 0;

//  This requires the Chilkat API to have been previously unlocked.
//  See Global Unlock Sample for sample code.

//  Important: It is helpful to send the contents of the
//  sftp.LastErrorText property when requesting support.

sftp := TChilkatSFtp.Create(Self);

//  Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs := 5000;
sftp.IdleTimeoutMs := 10000;

//  Connect to the SSH server.  
//  The standard SSH port = 22
//  The hostname may be a hostname or IP address.
hostname := 'www.my-sftp-server.com';
port := 22;
success := sftp.Connect(hostname,port);
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

//  Authenticate with the SSH server.  Chilkat SFTP supports
//  both password-based authenication as well as public-key
//  authentication.  This example uses password authenication.
success := sftp.AuthenticatePw('myLogin','myPassword');
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

//  After authenticating, the SFTP subsystem must be initialized:
success := sftp.InitializeSftp();
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

//  Open a directory on the server...
//  Paths starting with a slash are "absolute", and are relative 
//  to the root of the file system. Names starting with any other 
//  character are relative to the user's default directory (home directory).
//  A path component of ".." refers to the parent directory, 
//  and "." refers to the current directory. 
handle := sftp.OpenDir('.');
if (sftp.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

//  Download the directory listing:

dirListing := TChilkatSFtpDir.Create(Self);
success := sftp.ReadDirListing(handle,dirListing.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

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

//  Iterate over the files.
fileObj := TChilkatSFtpFile.Create(Self);
i := 0;
n := dirListing.NumFilesAndDirs;
while i < n do
  begin

    success := dirListing.FileAt(i,fileObj.ControlInterface);
    if (success = 0) then
      begin
        Memo1.Lines.Add(dirListing.LastErrorText);
        Exit;
      end;

    Memo1.Lines.Add(fileObj.Filename);
    Memo1.Lines.Add(fileObj.FileType);
    Memo1.Lines.Add('Size in bytes: ' + IntToStr(fileObj.Size32));
    Memo1.Lines.Add('----');

    i := i + 1;
  end;

Memo1.Lines.Add('Success.');