Unicode C++

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.

Unicode C++

#include <CkSshW.h>
#include <CkScpW.h>
#include <CkJsonObjectW.h>

void ChilkatSample(void)
    {
    bool success = false;

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

    CkSshW ssh;

    // First connect to an SSH server.
    success = ssh.Connect(L"example.com",22);
    if (success != true) {
        wprintf(L"%s\n",ssh.lastErrorText());
        return;
    }

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

    // Authenticate..
    success = ssh.AuthenticatePw(L"myLogin",L"myPassword");
    if (success != true) {
        wprintf(L"%s\n",ssh.lastErrorText());
        return;
    }

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

    success = scp.UseSsh(ssh);
    if (success != true) {
        wprintf(L"%s\n",scp.lastErrorText());
        return;
    }

    // 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".
    CkJsonObjectW jsonEnvVars;
    jsonEnvVars.put_EmitCompact(false);
    jsonEnvVars.UpdateString(L"LCS_PASSWORD",L"secret");
    jsonEnvVars.UpdateString(L"MY_TEST_NAME",L"abc");
    const wchar_t *strEnvVars = jsonEnvVars.emit();

    wprintf(L"%s\n",strEnvVars);

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

    // Do the upload..
    const wchar_t *remotePath = L"starfish.jpg";
    const wchar_t *localPath = L"qa_data/jpg/starfish.jpg";
    success = scp.UploadFile(localPath,remotePath);
    if (success != true) {
        wprintf(L"%s\n",scp.lastErrorText());
        return;
    }

    wprintf(L"SCP upload file success.\n");

    // Disconnect
    ssh.Disconnect();
    }