Pascal (Lazarus/Delphi)

SCP Download Text File to String Variable

See more SCP Examples

Downloads a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the 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.Ssh,
  Chilkat.Scp;

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

procedure RunDemo;
var
  success: Boolean;
  ssh: TSsh;
  hostname: string;
  port: Integer;
  scp: TScp;
  remotePath: string;
  charset: string;
  fileContents: string;

begin
  success := False;

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

  ssh := TSsh.Create;

  //  Hostname may be an IP address or hostname:
  hostname := 'www.some-ssh-server.com';
  port := 22;

  //  Connect to an SSH server:
  success := ssh.Connect(hostname,port);
  if (success <> True) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;

  //  Wait a max of 5 seconds when reading responses..
  ssh.IdleTimeoutMs := 5000;

  //  Authenticate using login/password:
  success := ssh.AuthenticatePw('myLogin','myPassword');
  if (success <> True) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;

  //  Once the SSH object is connected and authenticated, we use it
  //  in our SCP object.
  scp := TScp.Create;

  success := scp.UseSsh(ssh);
  if (success <> True) then
    begin
      WriteLn(scp.LastErrorText);
      Exit;
    end;

  //  This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).  
  remotePath := 'repository/xml/hamlet.xml';

  //  The byte representation of the remote text file (i.e. the charset) must be
  //  indicated to allow the receiving software to correctly interpret the incoming
  //  bytes as the correct chars.
  //  See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charset names.
  charset := 'utf-8';

  fileContents := scp.DownloadString(remotePath,charset);
  if (scp.LastMethodSuccess <> True) then
    begin
      WriteLn(scp.LastErrorText);
      Exit;
    end;

  WriteLn('Received file:');
  WriteLn(fileContents);

  WriteLn('SCP download string success.');

  //  Disconnect
  ssh.Disconnect();


  ssh.Free;
  scp.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.