Synchronize an SFTP Directory Tree to Local

See more SFTP Examples

Demonstrates the Chilkat SFtp.SyncTreeDownload method, which synchronizes a remote directory tree to a local directory. The arguments are the remote root, the local root, the sync mode, and whether to recurse into subdirectories.

Note: This example uses relative local paths, which are resolved against the application's current working directory. Absolute local paths may also be used. Supply the paths appropriate to your own environment.

#include <C_CkSFtp.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSFtp sftp;
    int port;
    const char *password;
    int mode;
    BOOL recurse;

    success = FALSE;

    //  Demonstrates the SFtp.SyncTreeDownload method, which synchronizes a remote directory tree to a
    //  local directory.  The 1st argument is the remote root, the 2nd is the local root, the 3rd is
    //  the sync mode, and the 4th selects recursion into subdirectories.

    sftp = CkSFtp_Create();

    //  Connect, authenticate, and initialize the SFTP subsystem.
    port = 22;
    success = CkSFtp_Connect(sftp,"sftp.example.com",port);
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        return;
    }

    //  Normally you would not hard-code the password in source.  You should instead obtain it
    //  from an interactive prompt, environment variable, or a secrets vault.
    password = "mySshPassword";

    success = CkSFtp_AuthenticatePw(sftp,"mySshLogin",password);
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        return;
    }

    success = CkSFtp_InitializeSftp(sftp);
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        return;
    }

    //  Sync mode 5 downloads files that are missing locally or differ in size, plus files that are
    //  newer on the server.  Other modes:
    //    0 = all files
    //    1 = files not existing locally
    //    2 = files newer remotely or missing locally
    //    3 = only files newer remotely (do not download missing)
    //    4 = files missing locally or differing in size
    //    5 = mode 4 plus files newer remotely
    mode = 5;
    recurse = TRUE;
    success = CkSFtp_SyncTreeDownload(sftp,"/var/www/html","qa_output/website",mode,recurse);
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        return;
    }

    printf("Directory tree downloaded.\n");

    CkSFtp_Disconnect(sftp);


    CkSFtp_Dispose(sftp);

    }