Xojo Plugin

Sync a Single FTP Directory Down to Local

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.

Background: This is the single-directory form of SyncLocalTree, using the same mode numbers but touching only the top level. It is the right choice when subdirectories are irrelevant or handled separately — for instance pulling new files from one drop folder without recursing into archive subfolders that would waste time to scan.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

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

Dim ftp As 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) Then
    System.DebugLog(ftp.LastErrorText)
    Return
End If

success = ftp.ChangeRemoteDir("public_html")
If (success = False) Then
    System.DebugLog(ftp.LastErrorText)
    Return
End If

//  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)

Dim mode As Int32
mode = 2
success = ftp.SyncLocalDir("qa_output/site",mode)
If (success = False) Then
    System.DebugLog(ftp.LastErrorText)
    Return
End If

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

success = ftp.Disconnect()
If (success = False) Then
    System.DebugLog(ftp.LastErrorText)
    Return
End If