(Lianja) SCP Download Text File to String Variable

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.

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loSsh = createobject("CkSsh")

// Hostname may be an IP address or hostname:
lcHostname = "www.some-ssh-server.com"
lnPort = 22

// Connect to an SSH server:
llSuccess = loSsh.Connect(lcHostname,lnPort)
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

// Wait a max of 5 seconds when reading responses..
loSsh.IdleTimeoutMs = 5000

// Authenticate using login/password:
llSuccess = loSsh.AuthenticatePw("myLogin","myPassword")
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

// Once the SSH object is connected and authenticated, we use it
// in our SCP object.
loScp = createobject("CkScp")

llSuccess = loScp.UseSsh(loSsh)
if (llSuccess <> .T.) then
    ? loScp.LastErrorText
    release loSsh
    release loScp
    return
endif

// This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).  
lcRemotePath = "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.
lcCharset = "utf-8"

lcFileContents = loScp.DownloadString(lcRemotePath,lcCharset)
if (loScp.LastMethodSuccess <> .T.) then
    ? loScp.LastErrorText
    release loSsh
    release loScp
    return
endif

? "Received file:"
? lcFileContents

? "SCP download string success."

// Disconnect
loSsh.Disconnect()


release loSsh
release loScp