(Xojo Plugin) FTP Non-Recursive Sync Directory (Download)

See more FTP Examples

Download files from the server that have filenames matchhing a pattern, and don't yet exist in a local directory.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim ftp As New Chilkat.Ftp2

ftp.Hostname = "ftp.example.com"
ftp.Username = "myUsername"
ftp.Password = "myPassword"
ftp.Port = 21
ftp.AuthTls = True

// Connect and login to the FTP server.
Dim success As Boolean
success = ftp.Connect()
If (success <> True) Then
    System.DebugLog(ftp.LastErrorText)
    Return
End If

// Change to the remote directory where the files are located.
// This step is only necessary if the files are not in the root directory
// of the FTP account.
success = ftp.ChangeRemoteDir("qa")
If (success <> True) Then
    System.DebugLog(ftp.LastErrorText)
    Return
End If

// Indicate that we only want to download files with filenames ending in ".txt"
ftp.SyncMustMatch = "*.txt"

// Modes for synchronization are as follows:
// mode=0: Download all files
// mode=1: Download all files that do not exist on the local filesystem.
// mode=2: Download newer or non-existant files.
// mode=3: Download only newer files. If a file does not already exist on the local filesystem, it is not downloaded from the server.
// mode=5: Download only missing files or files with size differences.
// mode=6: Same as mode 5, but also download newer files.
// mode=99: Do not download files, but instead delete remote files that do not exist locally.
Dim mode As Int32
mode = 1

// Download all files matching "*.txt" from the current remote ftp directory.
// The files are downloaded into c:/temp/qa_output
success = ftp.SyncLocalDir("c:/temp/qa_output",mode)
If (success <> True) Then
    System.DebugLog(ftp.LastErrorText)
    Return
End If

// We can see what files were downloaded in the SyncedFiles property,
// which lists the files one per line.
System.DebugLog(ftp.SyncedFiles)

// Perhaps we wish to delete the files we just downloaded from the server..
Dim sb As New Chilkat.StringBuilder
success = sb.Append(ftp.SyncedFiles)

Dim st As New Chilkat.StringTable
success = st.AppendFromSb(sb)

Dim numFiles As Int32
numFiles = st.Count
Dim i As Int32
i = 0
Dim remoteFilename As String
While i < numFiles
    remoteFilename = st.StringAt(i)
    System.DebugLog("Deleting " + remoteFilename + " from the FTP server")
    success = ftp.DeleteRemoteFile(remoteFilename)
    If (success <> True) Then
        System.DebugLog(ftp.LastErrorText)
        Return
    End If

    i = i + 1
Wend

success = ftp.Disconnect()