(Delphi DLL) SFTP Read Directory Listing

See more SFTP Examples

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

Chilkat for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, SFtpDir, SFtpFile, SFtp;

...

procedure TForm1.Button1Click(Sender: TObject);
var
sftp: HCkSFtp;
hostname: PWideChar;
port: Integer;
success: Boolean;
handle: PWideChar;
dirListing: HCkSFtpDir;
i: Integer;
n: Integer;
fileObj: HCkSFtpFile;

begin
// 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 := CkSFtp_Create();

// Set some timeouts, in milliseconds:
CkSFtp_putConnectTimeoutMs(sftp,5000);
CkSFtp_putIdleTimeoutMs(sftp,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 := CkSFtp_Connect(sftp,hostname,port);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    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 := CkSFtp_AuthenticatePw(sftp,'myLogin','myPassword');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

// After authenticating, the SFTP subsystem must be initialized:
success := CkSFtp_InitializeSftp(sftp);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    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 := CkSFtp__openDir(sftp,'.');
if (CkSFtp_getLastMethodSuccess(sftp) <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

// Download the directory listing:
dirListing := CkSFtp_ReadDir(sftp,handle);
if (CkSFtp_getLastMethodSuccess(sftp) <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

// Close the handle for the directory listing.
success := CkSFtp_CloseHandle(sftp,handle);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

// Iterate over the files.
i := 0;
n := CkSFtpDir_getNumFilesAndDirs(dirListing);
while i < n do
  begin
    fileObj := CkSFtpDir_GetFileObject(dirListing,i);

    Memo1.Lines.Add(CkSFtpFile__filename(fileObj));
    Memo1.Lines.Add(CkSFtpFile__fileType(fileObj));
    Memo1.Lines.Add('Size in bytes: ' + IntToStr(CkSFtpFile_getSize32(fileObj)));
    Memo1.Lines.Add('----');

    CkSFtpFile_Dispose(fileObj);

    i := i + 1;
  end;

CkSFtpDir_Dispose(dirListing);

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

CkSFtp_Dispose(sftp);

end;