Sample code for 30+ languages & platforms
Delphi ActiveX

SFTP Read Text File

See more SFTP Examples

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

Chilkat Delphi ActiveX Downloads

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

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Integer;
sftp: TChilkatSFtp;
hostname: WideString;
port: Integer;
handle: WideString;
sText: WideString;

begin
success := 0;

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

sftp := TChilkatSFtp.Create(Self);

// Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs := 5000;
sftp.IdleTimeoutMs := 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 := sftp.Connect(hostname,port);
if (success <> 1) 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 <> 1) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

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

// Open a file for reading.

handle := sftp.OpenFile('myTest.txt','readOnly','openExisting');
if (sftp.LastMethodSuccess <> 1) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    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 := sftp.ReadFileText(handle,26,'ansi');
if (sftp.LastMethodSuccess <> 1) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

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

// Read the next 10 bytes.
sText := sftp.ReadFileText(handle,10,'ansi');
if (sftp.LastMethodSuccess <> 1) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

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

// Read the next 26 bytes.
sText := sftp.ReadFileText(handle,26,'ansi');
if (sftp.LastMethodSuccess <> 1) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

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

// Close the file.
success := sftp.CloseHandle(handle);
if (success <> 1) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

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