Xojo Plugin

Get the Files Affected by an FTP Sync

Demonstrates the Chilkat Ftp2.GetSyncedFiles method, which reports the relative paths affected by the most recent synchronization. The only argument is a StringTable that receives the paths (uploaded, downloaded, or deleted).

Background: A sync call reports only overall success, but you usually want to know what actually changed — for logging, for triggering follow-up work on just the new files, or to confirm an incremental sync did the minimal transfer. An empty result is meaningful too: it means everything was already up to date. Call it immediately after the sync, before another operation replaces the recorded list.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the Ftp2.GetSyncedFiles method, which reports the relative paths affected by the
//  most recent synchronization operation.  The only argument is a StringTable that receives the
//  paths.

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

//  Perform a sync.
Dim mode As Int32
mode = 6
success = ftp.SyncLocalTree("qa_output/site",mode)
If (success = False) Then
    System.DebugLog(ftp.LastErrorText)
    Return
End If

//  Get the list of files that were uploaded, downloaded, or deleted by that sync.
Dim synced As New Chilkat.StringTable
ftp.GetSyncedFiles synced

Dim n As Int32
n = synced.Count
System.DebugLog("Affected files: " + Str(n))
Dim i As Int32
For i = 0 To n - 1
    Dim relPath As String
    relPath = synced.StringAt(i)
    If (synced.LastMethodSuccess = False) Then
        System.DebugLog(synced.LastErrorText)
        Return
    End If

    System.DebugLog(relPath)
Next

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