Pascal (Lazarus/Delphi)

SFTP Read Text File

See more SFTP Examples

Demonstrates how to open a text file on the SSH server and read text. 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.SFtp;

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

procedure RunDemo;
var
  success: Boolean;
  sftp: TSFtp;
  hostname: string;
  port: Integer;
  handle: string;
  sText: string;

begin
  success := False;

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

  sftp := TSFtp.Create;

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

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

  //  Open a file for reading.

  handle := sftp.OpenFile('myTest.txt','readOnly','openExisting');
  if (sftp.LastMethodSuccess <> True) then
    begin
      WriteLn(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 <> True) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  //  Should print "abcdefghijklmnopqrstuvwxyz";
  WriteLn(sText);

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

  //  Should print "1234567890";
  WriteLn(sText);

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

  //  Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
  WriteLn(sText);

  //  Close the file.
  success := sftp.CloseHandle(handle);
  if (success <> True) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  WriteLn('Success.');


  sftp.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.