(PureBasic) 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.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkStringTable.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkSFtp.pb"

Procedure ChilkatExample()

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

    sftp.i = CkSFtp::ckCreate()
    If sftp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkSFtp::ckConnect(sftp,"my-ssh-server.com",22)
    If success = 1
        success = CkSFtp::ckAuthenticatePw(sftp,"mySshLogin","mySshPassword")
    EndIf

    If success = 1
        success = CkSFtp::ckInitializeSftp(sftp)
    EndIf

    If success <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ; 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.

    remoteDir.s = "syncDownloadTest"
    localDir.s = "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.
    mode.i = 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.
    recursive.i = 1
    success = CkSFtp::ckSyncTreeDownload(sftp,remoteDir,localDir,mode,recursive)
    If success <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ; Examine the list of downloaded files.
    ; The downloaded files are listed one per line in the SyncedFiles property.
    ; Local directories that were created will be listed with a trailing "/" char.
    fileList.s = CkSFtp::ckSyncedFiles(sftp)
    Debug fileList
    Debug ""

    ; 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

    ; You could load the strings into a Chilkat string table..
    sb.i = CkStringBuilder::ckCreate()
    If sb.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sb,fileList)

    st.i = CkStringTable::ckCreate()
    If st.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringTable::ckAppendFromSb(st,sb)

    ; Find out how many files + dirs
    Debug "Total count = " + Str(CkStringTable::ckCount(st))

    i.i = 0
    While i < CkStringTable::ckCount(st)
        Debug CkStringTable::ckStringAt(st,i)
        i = i + 1
    Wend

    Debug "Success."


    CkSFtp::ckDispose(sftp)
    CkStringBuilder::ckDispose(sb)
    CkStringTable::ckDispose(st)


    ProcedureReturn
EndProcedure