(Delphi ActiveX) SCP Download Text File to String Variable

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.

Chilkat for Delphi Downloads Chilkat ActiveX DLL for Delphi Chilkat non-ActiveX DLL for Delphi * The examples here use the ActiveX DLL.

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
ssh: TChilkatSsh;
hostname: WideString;
port: Integer;
success: Integer;
scp: TChilkatScp;
remotePath: WideString;
charset: WideString;
fileContents: WideString;

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

ssh := TChilkatSsh.Create(Self);

// 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 <> 1) then
  begin
    Memo1.Lines.Add(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 <> 1) then
  begin
    Memo1.Lines.Add(ssh.LastErrorText);
    Exit;
  end;

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

success := scp.UseSsh(ssh.ControlInterface);
if (success <> 1) then
  begin
    Memo1.Lines.Add(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 <> 1) then
  begin
    Memo1.Lines.Add(scp.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add('Received file:');
Memo1.Lines.Add(fileContents);

Memo1.Lines.Add('SCP download string success.');

// Disconnect
ssh.Disconnect();
end;