Lua

Get a Filename from an FTP Directory Listing

Demonstrates the Chilkat Ftp2.GetFilename method, which returns the name of a cached directory-listing entry. The only argument is a zero-based index from 0 through GetDirCount - 1.

Background: The Chilkat FTP directory API is index-based and works from a single cached listing: the first GetDirCount call fetches the current directory's listing once, and every indexed accessor — name, size, type, permissions, timestamps — then reads from that cache without further server round trips. That makes iterating a directory efficient, but it also means the data reflects the moment the listing was fetched; call ClearDirCache to force a refresh after the remote directory changes.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Ftp2.GetFilename method, which returns the name of a cached directory-listing
-- entry.  The only argument is a zero-based index from 0 through GetDirCount - 1.

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

-- GetDirCount retrieves the directory listing on the first call and returns the number of
-- entries.  A negative return indicates failure.
local n = ftp:get_dir_count()
if n < 0 then
    print(ftp.last_error_text)
    return
end

for i = 0, n - 1 do
    local name = ftp:get_filename(i)
    print(name)
end

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