Lua

SFTP Read Text File

See more SFTP Examples

Demonstrates how to open a text file on the SSH server and read text. 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 for reading.
local handle = sftp:open_file("myTest.txt", "readOnly", "openExisting")
if not sftp.last_method_success then
    print(sftp.last_error_text)
    return
end

-- Assume the file we are reading contains the following text:
-- abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
-- (in ANSI format -- i.e. one byte per char).

-- Read 26 bytes:
local sText = sftp:read_file_text(handle, 26, "ansi")
if not sftp.last_method_success then
    print(sftp.last_error_text)
    return
end

-- Should print "abcdefghijklmnopqrstuvwxyz";
print(sText)

-- Read the next 10 bytes.
sText = sftp:read_file_text(handle, 10, "ansi")
if not sftp.last_method_success then
    print(sftp.last_error_text)
    return
end

-- Should print "1234567890";
print(sText)

-- Read the next 26 bytes.
sText = sftp:read_file_text(handle, 26, "ansi")
if not sftp.last_method_success then
    print(sftp.last_error_text)
    return
end

-- Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
print(sText)

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

print("Success.")