Lua

Get an FTP Listing Entry's Size (32-bit)

Demonstrates the Chilkat Ftp2.GetSize method, which returns the size in bytes of a cached directory-listing entry as a 32-bit integer. The only argument is a zero-based index. It returns -1 when the index is invalid or the size is unavailable.

Background: The size comes from the cached listing, so reading it for every entry costs no extra round trips. A 32-bit result cannot represent files past about 2 GB, so use GetSize64 (or GetSizeStr) when large files are possible. Directories often report no meaningful size and come back as -1, which is why the -1 case is worth handling rather than printing blindly.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Ftp2.GetSize method, which returns the size in bytes of a cached
-- directory-listing entry as a 32-bit integer.  The only argument is a zero-based index.

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)

    -- GetSize returns -1 when the index is invalid or the size is unavailable (for example for a
    -- directory).  Use GetSize64 for files that may exceed 2 GB.
    local fileSize = ftp:get_size(i)
    print(name .. "  " .. fileSize .. " bytes")
end

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