Lua

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 Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

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

local ftp = chilkat.Ftp2.new()

ftp.hostname = "ftp.example.com"
ftp.username = "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.
ftp.password = "myPassword"

local success = ftp:connect()
if not success then
    print(ftp.last_error_text)
    return
end

success = ftp:change_remote_dir("public_html")
if not success then
    print(ftp.last_error_text)
    return
end

-- Download all .html files from the current remote directory.  Subdirectories are not traversed.
local numDownloaded = ftp:mget_files("*.html", "qa_output/site")
if numDownloaded < 0 then
    print(ftp.last_error_text)
    return
end

print("Downloaded " .. numDownloaded .. " files.")

success = ftp:disconnect()
if not success then
    print(ftp.last_error_text)
    return
end