PowerBuilder

SFTP SyncTreeDownload - Find out what files were downloaded

See more SFTP Examples

Demonstrates how to find out which files were downloaded in a SyncTreeDownload method call. PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Sftp
string ls_RemoteDir
string ls_LocalDir
integer li_Mode
integer li_Recursive
oleobject loo_St
integer li_NumFiles
integer i
string ls_RemoteFilename

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

// Synchronize the remote directory tree rooted at "syncDownloadTest/xml"
// with the local directory tree rooted at "qa_output"
// Both directories are relative paths.  The remote directory
// is relative to the HOME directory of the SSH user account.
// The local directory is relative to the current working directory of the process.
// It is also possible to use absolute paths.

ls_RemoteDir = "syncDownloadTest"
ls_LocalDir = "qa_output"

// Possible modes that can be passed to the SyncTreeDownload method 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.
// mode=99: Do not download files, but instead delete remote files that do not exist locally.

// This example will use mode 6 to download missing, newer, or files with size differences.
li_Mode = 6
// This example will turn on recursion to synchronize the entire tree. 
// Recursion can be turned off to synchronize the files of a single directory.
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

// Examine the list of downloaded files.
loo_St = create oleobject
li_rc = loo_St.ConnectToNewObject("Chilkat.StringTable")

loo_Sftp.GetSyncedFiles(loo_St)

li_NumFiles = loo_St.Count
i = 0

do while i < li_NumFiles
    Write-Debug loo_St.StringAt(i)
    i = i + 1
loop

// For example:

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

Write-Debug "Success."


destroy loo_Sftp
destroy loo_St