Tcl

SCP Download Text File to String Variable

See more SCP Examples

Downloads a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server directly into a string variable. Tcl

load ./chilkat.dll

set success 0

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

set ssh [new_CkSsh]

# Hostname may be an IP address or hostname:
set hostname "www.some-ssh-server.com"
set port 22

# Connect to an SSH server:
set success [CkSsh_Connect $ssh $hostname $port]
if {$success != 1} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

# Wait a max of 5 seconds when reading responses..
CkSsh_put_IdleTimeoutMs $ssh 5000

# Authenticate using login/password:
set success [CkSsh_AuthenticatePw $ssh "myLogin" "myPassword"]
if {$success != 1} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

# Once the SSH object is connected and authenticated, we use it
# in our SCP object.
set scp [new_CkScp]

set success [CkScp_UseSsh $scp $ssh]
if {$success != 1} then {
    puts [CkScp_lastErrorText $scp]
    delete_CkSsh $ssh
    delete_CkScp $scp
    exit
}

# This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).  
set remotePath "repository/xml/hamlet.xml"

# The byte representation of the remote text file (i.e. the charset) must be
# indicated to allow the receiving software to correctly interpret the incoming
# bytes as the correct chars.
# See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charset names.
set charset "utf-8"

set fileContents [CkScp_downloadString $scp $remotePath $charset]
if {[CkScp_get_LastMethodSuccess $scp] != 1} then {
    puts [CkScp_lastErrorText $scp]
    delete_CkSsh $ssh
    delete_CkScp $scp
    exit
}

puts "Received file:"
puts "$fileContents"

puts "SCP download string success."

# Disconnect
CkSsh_Disconnect $ssh

delete_CkSsh $ssh
delete_CkScp $scp