PureBasic

Get the Entire Remote Directory Tree as XML

Demonstrates the Chilkat Ftp2.DirTreeXml method, which returns an XML representation of the complete remote directory tree rooted at the current remote directory. It takes no arguments; the result uses a <dirTree> root with nested <dir> and <file> elements.

Tip: Code to parse the returned XML can be generated at Chilkat Tools.

Background: This walks the whole subtree in one call and hands back its structure as nested XML — a convenient way to snapshot or audit an entire remote hierarchy without writing your own recursion. Be mindful that it visits every subdirectory, so on a large or deep tree it can be slow and produce a great deal of XML; scope it by changing into the specific directory you care about first.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkFtp2.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the Ftp2.DirTreeXml method, which returns an XML representation of the complete
    ;  remote directory tree rooted at the current remote directory.  It takes no arguments.

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

    CkFtp2::setCkHostname(ftp, "ftp.example.com")
    CkFtp2::setCkUsername(ftp, "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.
    CkFtp2::setCkPassword(ftp, "myPassword")

    success = CkFtp2::ckConnect(ftp)
    If success = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    success = CkFtp2::ckChangeRemoteDir(ftp,"public_html")
    If success = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    ;  The result uses a <dirTree> root with nested <dir> and <file> elements describing the whole
    ;  subtree.  This can be a large amount of data for a deep tree.
    treeXml.s = CkFtp2::ckDirTreeXml(ftp)
    If CkFtp2::ckLastMethodSuccess(ftp) = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    Debug treeXml

    success = CkFtp2::ckDisconnect(ftp)
    If success = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf



    CkFtp2::ckDispose(ftp)


    ProcedureReturn
EndProcedure