Pascal (Lazarus/Delphi)

SFTP Read Directory Listing

See more SFTP Examples

Demonstrates how to download a directory listing and iterate over the files. Pascal (Lazarus/Delphi)

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.SFtpDir,
  Chilkat.SFtpFile,
  Chilkat.SFtp;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  sftp: TSFtp;
  hostname: string;
  port: Integer;
  handle: string;
  dirListing: TSFtpDir;
  fileObj: TSFtpFile;
  i: Integer;
  n: Integer;

begin
  success := False;

  //  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 := TSFtp.Create;

  //  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 = False) then
    begin
      WriteLn(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 = False) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  //  After authenticating, the SFTP subsystem must be initialized:
  success := sftp.InitializeSftp();
  if (success = False) then
    begin
      WriteLn(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 = False) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  //  Download the directory listing:

  dirListing := TSFtpDir.Create;
  success := sftp.ReadDirListing(handle,dirListing);
  if (success = False) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  //  Close the handle for the directory listing.
  success := sftp.CloseHandle(handle);
  if (success = False) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

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

      success := dirListing.FileAt(i,fileObj);
      if (success = False) then
        begin
          WriteLn(dirListing.LastErrorText);
          Exit;
        end;

      WriteLn(fileObj.Filename);
      WriteLn(fileObj.FileType);
      WriteLn('Size in bytes: ' + fileObj.Size32);
      WriteLn('----');

      i := i + 1;
    end;

  WriteLn('Success.');


  sftp.Free;
  dirListing.Free;
  fileObj.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.