Visual FoxPro

Synchronize an SFTP Directory Tree to Local

Demonstrates the Chilkat SFtp.SyncTreeDownload method, which synchronizes a remote directory tree to a local directory. The arguments are the remote root, the local root, the sync mode, and whether to recurse into subdirectories.

Note: This example uses relative local paths, which are resolved against the application's current working directory. Absolute local paths may also be used. Supply the paths appropriate to your own environment.

Background: The mirror-image of SyncTreeUpload, used to pull a remote tree down — fetching logs, backing up a server directory, or refreshing a local copy of published content. The same mode numbers apply, now judged from the download direction: only-missing, only-newer-on-server, differing-size, and so on. Missing local directories are created as needed, and GetSyncedFiles reports both the files and the directories that resulted.

Chilkat Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

LOCAL lnSuccess
LOCAL loSftp
LOCAL lnPort
LOCAL lcPassword
LOCAL lnMode
LOCAL lnRecurse

lnSuccess = 0

*  Demonstrates the SFtp.SyncTreeDownload method, which synchronizes a remote directory tree to a
*  local directory.  The 1st argument is the remote root, the 2nd is the local root, the 3rd is
*  the sync mode, and the 4th selects recursion into subdirectories.

loSftp = CreateObject('Chilkat.SFtp')

*  Connect, authenticate, and initialize the SFTP subsystem.
lnPort = 22
lnSuccess = loSftp.Connect("sftp.example.com",lnPort)
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
ENDIF

*  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.
lcPassword = "mySshPassword"

lnSuccess = loSftp.AuthenticatePw("mySshLogin",lcPassword)
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
ENDIF

lnSuccess = loSftp.InitializeSftp()
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
ENDIF

*  Sync mode 5 downloads files that are missing locally or differ in size, plus files that are
*  newer on the server.  Other modes:
*    0 = all files
*    1 = files not existing locally
*    2 = files newer remotely or missing locally
*    3 = only files newer remotely (do not download missing)
*    4 = files missing locally or differing in size
*    5 = mode 4 plus files newer remotely
lnMode = 5
lnRecurse = 1
lnSuccess = loSftp.SyncTreeDownload("/var/www/html","qa_output/website",lnMode,lnRecurse)
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
ENDIF

? "Directory tree downloaded."

loSftp.Disconnect()

RELEASE loSftp