PureBasic

Download Multiple FTP Files by Wildcard (MGET)

Demonstrates the Chilkat Ftp2.MGetFiles method, which downloads files in the current remote directory matching a pattern into a local directory. The first argument is the remote pattern and the second is the local directory. It returns the number of files downloaded, or -1 on failure.

Note: The local paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background: This is FTP's mget: fetch everything matching a wildcard in one call rather than looping yourself. It operates on the current remote directory — hence the ChangeRemoteDir first — and does not descend into subdirectories; use DownloadTree for recursive transfers. The count return lets you confirm how many matched, with -1 signaling an outright failure to check separately from a legitimate zero.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkFtp2.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the Ftp2.MGetFiles method, which downloads files in the current remote directory
    ;  matching a pattern into a local directory.  The 1st argument is the remote pattern and the 2nd
    ;  is the local directory.  It returns the number of files downloaded, or -1 on failure.

    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

    ;  Download all .html files from the current remote directory.  Subdirectories are not traversed.
    numDownloaded.i = CkFtp2::ckMGetFiles(ftp,"*.html","qa_output/site")
    If numDownloaded < 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    Debug "Downloaded " + Str(numDownloaded) + " files."

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



    CkFtp2::ckDispose(ftp)


    ProcedureReturn
EndProcedure