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#

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

Chilkat.Ftp2 ftp = new Chilkat.Ftp2();

ftp.Hostname = "ftp.example.com";
ftp.Username = "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.
ftp.Password = "myPassword";

success = ftp.Connect();
if (success == false) {
    Debug.WriteLine(ftp.LastErrorText);
    return;
}

success = ftp.ChangeRemoteDir("public_html");
if (success == false) {
    Debug.WriteLine(ftp.LastErrorText);
    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.
string plan = ftp.CreatePlan("qa_data/site");
if (ftp.LastMethodSuccess == false) {
    Debug.WriteLine(ftp.LastErrorText);
    return;
}

//  Persist the plan text for later use.
Chilkat.StringBuilder sbPlan = new Chilkat.StringBuilder();
sbPlan.Append(plan);
success = sbPlan.WriteFile("qa_output/upload_plan.txt");
if (success == false) {
    Debug.WriteLine(sbPlan.LastErrorText);
    return;
}

Debug.WriteLine("Upload plan created.");

success = ftp.Disconnect();
if (success == false) {
    Debug.WriteLine(ftp.LastErrorText);
    return;
}