Lua

SFTP Read Text File to String

See more SFTP Examples

Demonstrates how to download a text file from an SSH server directly into a string variable. Lua

local chilkat = require("chilkat")

-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.

local sftp = chilkat.SFtp.new()

-- Set some timeouts, in milliseconds:
sftp.connect_timeout_ms = 5000
sftp.idle_timeout_ms = 15000

-- Connect to the SSH server.
-- The standard SSH port = 22
-- The hostname may be a hostname or IP address.
local hostname = "sftp.example.com"
local port = 22
local success = sftp:connect(hostname, port)
if not success then
    print(sftp.last_error_text)
    return
end

-- Authenticate with the SSH server.  Chilkat SFTP supports
-- both password-based authenication as well as public-key
-- authentication.  This example uses password authenication.
success = sftp:authenticate_pw("myLogin", "myPassword")
if not success then
    print(sftp.last_error_text)
    return
end

-- After authenticating, the SFTP subsystem must be initialized:
success = sftp:initialize_sftp()
if not success then
    print(sftp.last_error_text)
    return
end

-- Open a file on the server:
local handle = sftp:open_file("hamlet.xml", "readOnly", "openExisting")
if not sftp.last_method_success then
    print(sftp.last_error_text)
    return
end

-- Get the total size of this file (in bytes)
local bFollowLinks = false
local bIsHandle = true

-- bFollowLinks is ignored because we are passing a handle
-- and not a remote filename.
-- There are alternative methods for handling file sizes
-- greater than 32-bit.  (See the reference documentation.)
local numBytes = sftp:get_file_size32(handle, bFollowLinks, bIsHandle)
if numBytes < 0 then
    print(sftp.last_error_text)
    return
end

-- The charset indicates the character encoding of the text
-- file on the SSH server.   Setting the charset correctly
-- allows the Chilkat SFTP component to correctly interpret
-- the bytes that represent the characters.
local charset = "ansi"
local fileContents = sftp:read_file_text(handle, numBytes, charset)
if not sftp.last_method_success then
    print(sftp.last_error_text)
    return
else
    print("Received file:")
    print(fileContents)
end

-- Close the file.
success = sftp:close_handle(handle)
if not success then
    print(sftp.last_error_text)
    return
end

print("Success.")