SFTP Read Text File

Demonstrates how to open a text file on the SSH server and read text.

Downloads for Windows/Linux and Install Instructions

require 'rubygems'
require 'chilkat'

#  Important: It is helpful to send the contents of the
#  sftp.LastErrorText property when requesting support.

sftp = Chilkat::CkSFtp.new()

#  Any string automatically begins a fully-functional 30-day trial.
success = sftp.UnlockComponent("Anything for 30-day trial")
if (success != true)
    print sftp.lastErrorText() + "\n"
    exit
end

#  Set some timeouts, in milliseconds:
sftp.put_ConnectTimeoutMs(5000)
sftp.put_IdleTimeoutMs(15000)

#  Connect to the SSH server.
#  The standard SSH port = 22
#  The hostname may be a hostname or IP address.

hostname = "www.my-ssh-server.com"
port = 22
success = sftp.Connect(hostname,port)
if (success != true)
    print sftp.lastErrorText() + "\n"
    exit
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.AuthenticatePw("myLogin","myPassword")
if (success != true)
    print sftp.lastErrorText() + "\n"
    exit
end

#  After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
if (success != true)
    print sftp.lastErrorText() + "\n"
    exit
end

#  Open a file for reading.

handle = sftp.openFile("myTest.txt","readOnly","openExisting")
if (handle == nil )
    print sftp.lastErrorText() + "\n"
    exit
end

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

#  Read 26 bytes:

sText = sftp.readFileText(handle,26,"ansi")
if (success != true)
    print sftp.lastErrorText() + "\n"
    exit
end

#  Should print "abcdefghijklmnopqrstuvwxyz"
print sText + "\n";

#  Read the next 10 bytes.
sText = sftp.readFileText(handle,10,"ansi")
if (success != true)
    print sftp.lastErrorText() + "\n"
    exit
end

#  Should print "1234567890"
print sText + "\n";

#  Read the next 26 bytes.
sText = sftp.readFileText(handle,26,"ansi")
if (success != true)
    print sftp.lastErrorText() + "\n"
    exit
end

#  Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
print sText + "\n";

#  Close the file.
success = sftp.CloseHandle(handle)
if (success != true)
    print sftp.lastErrorText() + "\n"
    exit
end

print "Success." + "\n"