Lua

Download an FTP File as Text with a Charset

Demonstrates the Chilkat Ftp2.GetRemoteFileTextC method, which downloads a remote file, decodes the bytes using a named charset, and returns the text. The first argument is the remote filename and the second is the charset. A byte-order mark for the selected encoding is recognized and omitted.

Background: This is the encoding-aware way to read a remote text file: you name the charset (utf-8, iso-8859-1, and so on) so multibyte and accented characters decode correctly, and a leading BOM is stripped automatically. Prefer it over GetRemoteFileTextData whenever the file's encoding is known, which is almost always.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Ftp2.GetRemoteFileTextC method, which downloads a remote file, decodes the
-- bytes using a named charset, and returns the text.  The 1st argument is the remote filename
-- and the 2nd is the charset.

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

-- Download a UTF-8 text file.  A byte-order mark for the selected encoding is recognized and
-- omitted from the returned text.
local fileText = ftp:get_remote_file_text_c("public_html/readme.txt", "utf-8")
if not ftp.last_method_success then
    print(ftp.last_error_text)
    return
end

print(fileText)

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