Sync a Single FTP Directory Down to Local

See more FTP Examples

Demonstrates the Chilkat Ftp2.SyncLocalDir method, which synchronizes files from the current remote directory into a local directory without descending into subdirectories. The first argument is the local root and the second is the download mode.

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.

IncludeFile "CkFtp2.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the Ftp2.SyncLocalDir method, which synchronizes files from the current remote
    ;  directory into a local directory WITHOUT descending into subdirectories.  The 1st argument is
    ;  the local root and the 2nd is the download mode.

    ftp.i = CkFtp2::ckCreate()
    If ftp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkFtp2::setCkHostname(ftp, "ftp.example.com")
    CkFtp2::setCkUsername(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::setCkPassword(ftp, "myPassword")

    success = CkFtp2::ckConnect(ftp)
    If success = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    success = CkFtp2::ckChangeRemoteDir(ftp,"public_html")
    If success = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    ;  This is the single-directory (non-recursive) form of SyncLocalTree; it uses the same modes.
    ;    0 = all selected files
    ;    1 = files missing locally
    ;    2 = missing locally, or newer on the server
    ;    3 = only files that exist locally and are newer on the server
    ;    5 = missing locally, or a different size
    ;    6 = missing, different size, or newer on the server
    ;   99 = do not download; delete local... (see docs)

    mode.i = 2
    success = CkFtp2::ckSyncLocalDir(ftp,"qa_output/site",mode)
    If success = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    Debug "Remote directory synced to local (top level only)."

    success = CkFtp2::ckDisconnect(ftp)
    If success = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf



    CkFtp2::ckDispose(ftp)


    ProcedureReturn
EndProcedure