PowerBuilder

SFTP Sync Download Tree w/ Must-Match Filename Constraints

See more SFTP Examples

Demonstrates how synchronize a directory tree in the download direction, but only download files matching a set of wildcard filenames.

Note: This example requires Chilkat v9.5.0.76 or greater.

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Sftp
string ls_RemoteDir
string ls_LocalDir
integer li_Mode
integer li_Recursive

li_Success = 0

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

loo_Sftp = create oleobject
li_rc = loo_Sftp.ConnectToNewObject("Chilkat.SFtp")
if li_rc < 0 then
    destroy loo_Sftp
    MessageBox("Error","Connecting to COM object failed")
    return
end if

li_Success = loo_Sftp.Connect("my-ssh-server.com",22)
if li_Success = 1 then
    li_Success = loo_Sftp.AuthenticatePw("mySshLogin","mySshPassword")
end if

if li_Success = 1 then
    li_Success = loo_Sftp.InitializeSftp()
end if

if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

// Possible synchronization modes are:
// 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.

// This example will download all files, but only those files having filenames
// that match *.gif and *.eml

// Imagine our remote directory tree has these files and directories:

// 	accentedLatin1.txt
// 	accentedUtf8.txt
// 	alice.key
// 	anter_cert.pem
// 	chiliPepper.gif
// 	helloWorld.pdf
// 	abc/chiliPepper.gif
// 	abc/ghk/
// 	data/chiliPepper.gif
// 	data/xyz/dkimHtmlBody.txt
// 	data/xyz/dkimVerifyTest.eml
// 	data/xyz/emailForCreateDsn.eml
// 	text/frenchUtf8.txt
// 	text/helloWorld.txt
// 	text/PolishEmailBody.txt
// 	text/something/

// Indicate that we only want to create auto-create local directories (if needed)
// for the files that are actually downloaded.  If SyncCreateAllLocalDirs remains
// 1, then the corresponding local directory is created for each remote directory
// traversed regardless of whether files within are downloaded.
loo_Sftp.SyncCreateAllLocalDirs = 0

loo_Sftp.SyncMustMatch = "*.eml; *.gif"

ls_RemoteDir = "syncDownloadTest/someDir"
ls_LocalDir = "qa_output"
li_Mode = 0
li_Recursive = 1
li_Success = loo_Sftp.SyncTreeDownload(ls_RemoteDir,ls_LocalDir,li_Mode,li_Recursive)
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

// The following files were downloaded:

// chiliPepper.gif
// abc/chiliPepper.gif
// data/chiliPepper.gif
// data/xyz/dkimVerifyTest.eml
// data/xyz/emailForCreateDsn.eml

Write-Debug "Success."


destroy loo_Sftp