Tcl

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. 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 on the server:

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

# Get the total size of this file (in bytes)
set bFollowLinks 0
set bIsHandle 1

# 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.)
set numBytes [CkSFtp_GetFileSize32 $sftp $handle $bFollowLinks $bIsHandle]
if {$numBytes < 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

# 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.

set charset "ansi"

set fileContents [CkSFtp_readFileText $sftp $handle $numBytes $charset]
if {[CkSFtp_get_LastMethodSuccess $sftp] != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
} else {
    puts "Received file:"
    puts "$fileContents"
}

# 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