Pascal (Lazarus/Delphi)

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.

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.Scp,
  Chilkat.Ssh,
  Chilkat.JsonObject;

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

procedure RunDemo;
var
  success: Boolean;
  ssh: TSsh;
  scp: TScp;
  jsonEnvVars: TJsonObject;
  strEnvVars: string;
  remotePath: string;
  localPath: 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;

  //  First connect to an SSH server.
  success := ssh.Connect('example.com',22);
  if (success <> True) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;

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

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

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

  success := scp.UseSsh(ssh);
  if (success <> True) then
    begin
      WriteLn(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 := TJsonObject.Create;
  jsonEnvVars.EmitCompact := False;
  jsonEnvVars.UpdateString('LCS_PASSWORD','secret');
  jsonEnvVars.UpdateString('MY_TEST_NAME','abc');
  strEnvVars := jsonEnvVars.Emit();

  WriteLn(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 <> True) then
    begin
      WriteLn(scp.LastErrorText);
      Exit;
    end;

  WriteLn('SCP upload file success.');

  //  Disconnect
  ssh.Disconnect();


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