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

#include <C_CkSsh.h>
#include <C_CkScp.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSsh ssh;
    const char *hostname;
    int port;
    HCkScp scp;
    const char *remotePath;
    const char *charset;
    const char *fileContents;

    success = FALSE;

    // 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) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        CkSsh_Dispose(ssh);
        return;
    }

    // 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) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        CkSsh_Dispose(ssh);
        return;
    }

    // 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) {
        printf("%s\n",CkScp_lastErrorText(scp));
        CkSsh_Dispose(ssh);
        CkScp_Dispose(scp);
        return;
    }

    // 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) {
        printf("%s\n",CkScp_lastErrorText(scp));
        CkSsh_Dispose(ssh);
        CkScp_Dispose(scp);
        return;
    }

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

    printf("SCP download string success.\n");

    // Disconnect
    CkSsh_Disconnect(ssh);


    CkSsh_Dispose(ssh);
    CkScp_Dispose(scp);

    }