Execute an FTP Upload Plan

See more FTP Examples

Demonstrates the Chilkat Ftp2.PutPlan method, which executes a previously created upload plan. The first argument is the plan text and the second is the local path of a completion log that records each successful operation.

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: The completion log is what makes plan execution resumable: each successful upload is recorded, so if a run is interrupted, re-executing the same plan skips the operations already logged and continues where it left off — invaluable for a large transfer over a flaky connection. The plan's stored absolute remote paths are used regardless of the current remote directory, so execution is independent of session state.

Chilkat C Downloads

Download Chilkat for C

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

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

    success = FALSE;

    //  Demonstrates the Ftp2.PutPlan method, which executes a previously created upload plan.  The 1st
    //  argument is the plan text and the 2nd is the local path of a completion log.

    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;
    }

    //  Load a plan that was previously created with CreatePlan.
    sbPlan = CkStringBuilder_Create();
    success = CkStringBuilder_LoadFile(sbPlan,"qa_output/upload_plan.txt","utf-8");
    if (success == FALSE) {
        printf("%s\n",CkStringBuilder_lastErrorText(sbPlan));
        CkFtp2_Dispose(ftp);
        CkStringBuilder_Dispose(sbPlan);
        return;
    }

    plan = CkStringBuilder_getAsString(sbPlan);

    //  Execute the plan.  Each successful operation is recorded in the completion log, which lets an
    //  interrupted run be resumed without repeating completed uploads.  The plan uses its stored
    //  absolute remote paths even if the current remote directory has changed.
    success = CkFtp2_PutPlan(ftp,plan,"qa_output/upload_done.log");
    if (success == FALSE) {
        printf("%s\n",CkFtp2_lastErrorText(ftp));
        CkFtp2_Dispose(ftp);
        CkStringBuilder_Dispose(sbPlan);
        return;
    }

    printf("Upload plan executed.\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);

    }