Create an FTP Upload Plan

See more FTP Examples

Demonstrates the Chilkat Ftp2.CreatePlan method, which creates and returns a textual upload plan for a local directory. The only argument is the local directory. The object must be connected, because the plan records the current absolute remote directory together with the local source paths.

Note: The local paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background: A plan is a saved, resumable description of an upload — the list of local files and their absolute remote destinations — computed once and executed later (or on another run) with PutPlan. Separating planning from execution suits large or unreliable transfers: the plan can be reviewed, stored, and re-run, and because it records absolute remote paths it stays correct even if the working directory later changes.

Chilkat C Downloads

Download Chilkat for C

#include <C_CkFtp2.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkFtp2 ftp;
    const char *plan;
    HCkStringBuilder sbPlan;

    success = FALSE;

    //  Demonstrates the Ftp2.CreatePlan method, which creates and returns a textual upload plan for a
    //  local directory.  The only argument is the local directory.  The object must be connected,
    //  because the plan records the current absolute remote directory.

    ftp = CkFtp2_Create();

    CkFtp2_putHostname(ftp,"ftp.example.com");
    CkFtp2_putUsername(ftp,"myFtpLogin");

    //  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.
    CkFtp2_putPassword(ftp,"myPassword");

    success = CkFtp2_Connect(ftp);
    if (success == FALSE) {
        printf("%s\n",CkFtp2_lastErrorText(ftp));
        CkFtp2_Dispose(ftp);
        return;
    }

    success = CkFtp2_ChangeRemoteDir(ftp,"public_html");
    if (success == FALSE) {
        printf("%s\n",CkFtp2_lastErrorText(ftp));
        CkFtp2_Dispose(ftp);
        return;
    }

    //  The plan captures which local files to upload and the absolute remote destination.  Save it so
    //  the upload can be run (or resumed) later with PutPlan.
    plan = CkFtp2_createPlan(ftp,"qa_data/site");
    if (CkFtp2_getLastMethodSuccess(ftp) == FALSE) {
        printf("%s\n",CkFtp2_lastErrorText(ftp));
        CkFtp2_Dispose(ftp);
        return;
    }

    //  Persist the plan text for later use.
    sbPlan = CkStringBuilder_Create();
    CkStringBuilder_Append(sbPlan,plan);
    success = CkStringBuilder_WriteFile(sbPlan,"qa_output/upload_plan.txt");
    if (success == FALSE) {
        printf("%s\n",CkStringBuilder_lastErrorText(sbPlan));
        CkFtp2_Dispose(ftp);
        CkStringBuilder_Dispose(sbPlan);
        return;
    }

    printf("Upload plan created.\n");

    success = CkFtp2_Disconnect(ftp);
    if (success == FALSE) {
        printf("%s\n",CkFtp2_lastErrorText(ftp));
        CkFtp2_Dispose(ftp);
        CkStringBuilder_Dispose(sbPlan);
        return;
    }



    CkFtp2_Dispose(ftp);
    CkStringBuilder_Dispose(sbPlan);

    }