Pascal (Lazarus/Delphi)

SFTP Read Text File to String

See more SFTP Examples

Demonstrates how to download a text file from an SSH server directly into a string variable. 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;
  bFollowLinks: Boolean;
  bIsHandle: Boolean;
  numBytes: Integer;
  charset: string;
  fileContents: 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 on the server:

  handle := sftp.OpenFile('hamlet.xml','readOnly','openExisting');
  if (sftp.LastMethodSuccess <> True) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  //  Get the total size of this file (in bytes)
  bFollowLinks := False;
  bIsHandle := True;

  //  bFollowLinks is ignored because we are passing a handle
  //  and not a remote filename.
  //  There are alternative methods for handling file sizes
  //  greater than 32-bit.  (See the reference documentation.)
  numBytes := sftp.GetFileSize32(handle,bFollowLinks,bIsHandle);
  if (numBytes < 0) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  //  The charset indicates the character encoding of the text
  //  file on the SSH server.   Setting the charset correctly
  //  allows the Chilkat SFTP component to correctly interpret
  //  the bytes that represent the characters.

  charset := 'ansi';

  fileContents := sftp.ReadFileText(handle,numBytes,charset);
  if (sftp.LastMethodSuccess <> True) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end
  else
    begin
      WriteLn('Received file:');
      WriteLn(fileContents);
    end;

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