C++

SFTP Simplified Download

See more SFTP Examples

Demonstrates how to SFTP download a file by passing a remote filepath to DownloadFileByName. C++

#include <CkSFtp.h>

void ChilkatSample(void)
    {
    bool success = false;

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

    CkSFtp sftp;

    // Set some timeouts, in milliseconds:
    sftp.put_ConnectTimeoutMs(15000);
    sftp.put_IdleTimeoutMs(15000);

    // Connect to the SSH server.  
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    const char *hostname = "sftp.example.com";
    int port = 22;
    success = sftp.Connect(hostname,port);
    if (success != true) {
        std::cout << sftp.lastErrorText() << "\r\n";
        return;
    }

    // Authenticate with the SSH server.  Chilkat SFTP supports
    // both password-based authenication as well as public-key
    // authentication.  This example uses password authenication.
    success = sftp.AuthenticatePw("myLogin","myPassword");
    if (success != true) {
        std::cout << sftp.lastErrorText() << "\r\n";
        return;
    }

    // After authenticating, the SFTP subsystem must be initialized:
    success = sftp.InitializeSftp();
    if (success != true) {
        std::cout << sftp.lastErrorText() << "\r\n";
        return;
    }

    // Download the file:
    const char *remoteFilePath = 0;
    const char *localFilePath = 0;
    localFilePath = "c:/temp/hamlet.xml";
    // Note: The remote filepath may be an absolute filepath,
    // a relative filepath, or simply a filename.  
    // Relative filepaths are always relative to the home directory
    // of the SFTP/SSH user account.  There is no such thing
    // as "current remote directory" in the SFTP protocol. 
    // A filename with no path implies that the file is located
    // in the SFTP user account's home directory.
    remoteFilePath = "subdir1/subdir2/hamlet.xml";
    success = sftp.DownloadFileByName(remoteFilePath,localFilePath);
    if (success != true) {
        std::cout << sftp.lastErrorText() << "\r\n";
        return;
    }

    std::cout << "Success." << "\r\n";
    }