(Delphi DLL) 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 non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Ssh, Scp;

...

procedure TForm1.Button1Click(Sender: TObject);
var
ssh: HCkSsh;
hostname: PWideChar;
port: Integer;
success: Boolean;
scp: HCkScp;
remotePath: PWideChar;
charset: PWideChar;
fileContents: PWideChar;

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

ssh := CkSsh_Create();

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

// Connect to an SSH server:
success := CkSsh_Connect(ssh,hostname,port);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// Wait a max of 5 seconds when reading responses..
CkSsh_putIdleTimeoutMs(ssh,5000);

// Authenticate using login/password:
success := CkSsh_AuthenticatePw(ssh,'myLogin','myPassword');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

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

success := CkScp_UseSsh(scp,ssh);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkScp__lastErrorText(scp));
    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 := CkScp__downloadString(scp,remotePath,charset);
if (CkScp_getLastMethodSuccess(scp) <> True) then
  begin
    Memo1.Lines.Add(CkScp__lastErrorText(scp));
    Exit;
  end;

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

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

// Disconnect
CkSsh_Disconnect(ssh);

CkSsh_Dispose(ssh);
CkScp_Dispose(scp);

end;