Unicode C

SCP Download Text File to String Variable

See more SCP Examples

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. Unicode C

#include <C_CkSshW.h>
#include <C_CkScpW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSshW ssh;
    const wchar_t *hostname;
    int port;
    HCkScpW scp;
    const wchar_t *remotePath;
    const wchar_t *charset;
    const wchar_t *fileContents;

    success = FALSE;

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

    ssh = CkSshW_Create();

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

    // Connect to an SSH server:
    success = CkSshW_Connect(ssh,hostname,port);
    if (success != TRUE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

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

    // Authenticate using login/password:
    success = CkSshW_AuthenticatePw(ssh,L"myLogin",L"myPassword");
    if (success != TRUE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

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

    success = CkScpW_UseSsh(scp,ssh);
    if (success != TRUE) {
        wprintf(L"%s\n",CkScpW_lastErrorText(scp));
        CkSshW_Dispose(ssh);
        CkScpW_Dispose(scp);
        return;
    }

    // This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).  
    remotePath = L"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 = L"utf-8";

    fileContents = CkScpW_downloadString(scp,remotePath,charset);
    if (CkScpW_getLastMethodSuccess(scp) != TRUE) {
        wprintf(L"%s\n",CkScpW_lastErrorText(scp));
        CkSshW_Dispose(ssh);
        CkScpW_Dispose(scp);
        return;
    }

    wprintf(L"Received file:\n");
    wprintf(L"%s\n",fileContents);

    wprintf(L"SCP download string success.\n");

    // Disconnect
    CkSshW_Disconnect(ssh);


    CkSshW_Dispose(ssh);
    CkScpW_Dispose(scp);

    }