Delphi DLL

SFTP Read Text File

See more SFTP Examples

Demonstrates how to open a text file on the SSH server and read text. Delphi DLL

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

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
sftp: HCkSFtp;
hostname: PWideChar;
port: Integer;
handle: PWideChar;
sText: PWideChar;

begin
success := False;

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

sftp := CkSFtp_Create();

// Set some timeouts, in milliseconds:
CkSFtp_putConnectTimeoutMs(sftp,5000);
CkSFtp_putIdleTimeoutMs(sftp,15000);

// Connect to the SSH server.  
// The standard SSH port = 22
// The hostname may be a hostname or IP address.
hostname := 'sftp.example.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 file for reading.

handle := CkSFtp__openFile(sftp,'myTest.txt','readOnly','openExisting');
if (CkSFtp_getLastMethodSuccess(sftp) <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

// Assume the file we are reading contains the following text:
// abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
// (in ANSI format -- i.e. one byte per char).

// Read 26 bytes:

sText := CkSFtp__readFileText(sftp,handle,26,'ansi');
if (CkSFtp_getLastMethodSuccess(sftp) <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

// Should print "abcdefghijklmnopqrstuvwxyz"
Memo1.Lines.Add(sText);

// Read the next 10 bytes.
sText := CkSFtp__readFileText(sftp,handle,10,'ansi');
if (CkSFtp_getLastMethodSuccess(sftp) <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

// Should print "1234567890"
Memo1.Lines.Add(sText);

// Read the next 26 bytes.
sText := CkSFtp__readFileText(sftp,handle,26,'ansi');
if (CkSFtp_getLastMethodSuccess(sftp) <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

// Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
Memo1.Lines.Add(sText);

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

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

CkSFtp_Dispose(sftp);

end;