Tcl

SFTP Read Text File

See more SFTP Examples

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

load ./chilkat.dll

set success 0

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

set sftp [new_CkSFtp]

# Set some timeouts, in milliseconds:
CkSFtp_put_ConnectTimeoutMs $sftp 5000
CkSFtp_put_IdleTimeoutMs $sftp 15000

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
set hostname "sftp.example.com"
set port 22
set success [CkSFtp_Connect $sftp $hostname $port]
if {$success != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

# Authenticate with the SSH server.  Chilkat SFTP supports
# both password-based authenication as well as public-key
# authentication.  This example uses password authenication.
set success [CkSFtp_AuthenticatePw $sftp "myLogin" "myPassword"]
if {$success != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

# After authenticating, the SFTP subsystem must be initialized:
set success [CkSFtp_InitializeSftp $sftp]
if {$success != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

# Open a file for reading.

set handle [CkSFtp_openFile $sftp "myTest.txt" "readOnly" "openExisting"]
if {[CkSFtp_get_LastMethodSuccess $sftp] != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

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

# Read 26 bytes:

set sText [CkSFtp_readFileText $sftp $handle 26 "ansi"]
if {[CkSFtp_get_LastMethodSuccess $sftp] != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

# Should print "abcdefghijklmnopqrstuvwxyz"
puts "$sText"

# Read the next 10 bytes.
set sText [CkSFtp_readFileText $sftp $handle 10 "ansi"]
if {[CkSFtp_get_LastMethodSuccess $sftp] != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

# Should print "1234567890"
puts "$sText"

# Read the next 26 bytes.
set sText [CkSFtp_readFileText $sftp $handle 26 "ansi"]
if {[CkSFtp_get_LastMethodSuccess $sftp] != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

# Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
puts "$sText"

# Close the file.
set success [CkSFtp_CloseHandle $sftp $handle]
if {$success != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

puts "Success."

delete_CkSFtp $sftp