Delphi ActiveX

Setting Environment Variables for SCP Transfers

See more SCP Examples

Demonstrates how to set remote environment variables for an SCP transfer.

Note 1: This example requires Chilkat v9.5.0.79 or greater.

Note 2: Setting environment variables for SCP is only supported by some SSH servers.

Delphi ActiveX

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
success: Integer;
ssh: TChilkatSsh;
scp: TChilkatScp;
jsonEnvVars: TChilkatJsonObject;
strEnvVars: WideString;
remotePath: WideString;
localPath: WideString;

begin
success := 0;

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

ssh := TChilkatSsh.Create(Self);

// First connect to an SSH server.
success := ssh.Connect('example.com',22);
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..
success := ssh.AuthenticatePw('myLogin','myPassword');
if (success <> 1) then
  begin
    Memo1.Lines.Add(ssh.LastErrorText);
    Exit;
  end;

// After the SSH object is connected and authenticated, we use it
// as the underlying transport 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;

// Specify the environment variables to be set in JSON as follows.
// This example sets two environment variables.  One is named "LCS_PASSWORD" and the other "MY_TEST_NAME".
jsonEnvVars := TChilkatJsonObject.Create(Self);
jsonEnvVars.EmitCompact := 0;
jsonEnvVars.UpdateString('LCS_PASSWORD','secret');
jsonEnvVars.UpdateString('MY_TEST_NAME','abc');
strEnvVars := jsonEnvVars.Emit();

Memo1.Lines.Add(strEnvVars);

// Setting the SendEnv property causes Chilkat to set each environment variable on the SSH server
// prior to doing the upload or download.
scp.SendEnv := strEnvVars;

// Do the upload..
remotePath := 'starfish.jpg';
localPath := 'qa_data/jpg/starfish.jpg';
success := scp.UploadFile(localPath,remotePath);
if (success <> 1) then
  begin
    Memo1.Lines.Add(scp.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add('SCP upload file success.');

// Disconnect
ssh.Disconnect();
end;