VBScript

Filter Files and Directories in an FTP Sync

Demonstrates the synchronization filter properties SyncMustMatch, SyncMustNotMatch, SyncMustMatchDir, SyncMustNotMatchDir, and SyncCreateAllLocalDirs.

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 real sync rarely wants every file. These semicolon-separated wildcard filters shape the set: the MustMatch pairs include only matching files/directories, while the MustNotMatch pairs exclude them — letting you, say, publish only web assets while skipping build artifacts and caches. Directory filters also prune traversal, avoiding wasted time descending into folders you do not need. They apply to the tree-sync methods such as SyncLocalTree and SyncRemoteTree.

Chilkat VBScript Downloads

Download Chilkat for VBScript

VBScript

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

success = 0

set ftp = CreateObject("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 = 0) Then
    outFile.WriteLine(ftp.LastErrorText)
    WScript.Quit
End If

success = ftp.ChangeRemoteDir("public_html")
If (success = 0) Then
    outFile.WriteLine(ftp.LastErrorText)
    WScript.Quit
End If

'  Include only files matching these semicolon-separated, case-insensitive wildcard patterns.
ftp.SyncMustMatch = "*.html;*.css;*.js"

'  Exclude files matching these patterns, even if they matched SyncMustMatch.
ftp.SyncMustNotMatch = "*.tmp;*.bak"

'  Restrict which directories are traversed (and which are skipped) during a tree sync.
ftp.SyncMustMatchDir = "assets;pages"
ftp.SyncMustNotMatchDir = "cache;node_modules"

'  For a download sync, create empty remote directories on the local side too.
ftp.SyncCreateAllLocalDirs = 1

'  The filters apply to the tree sync operations, such as SyncLocalTree.
mode = 6
success = ftp.SyncLocalTree("qa_output/site",mode)
If (success = 0) Then
    outFile.WriteLine(ftp.LastErrorText)
    WScript.Quit
End If

outFile.WriteLine("Filtered sync complete.")

success = ftp.Disconnect()
If (success = 0) Then
    outFile.WriteLine(ftp.LastErrorText)
    WScript.Quit
End If


outFile.Close