Xbase++

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. Xbase++

LOCAL nSuccess
LOCAL oSsh
LOCAL cHostname
LOCAL nPort
LOCAL oScp
LOCAL cRemotePath
LOCAL cCharset
LOCAL cFileContents

nSuccess := 0

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

oSsh := CreateObject("Chilkat.Ssh")

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

//  Connect to an SSH server:
nSuccess := oSsh:Connect(cHostname, nPort)
IF (nSuccess != 1)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

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

//  Authenticate using login/password:
nSuccess := oSsh:AuthenticatePw("myLogin", "myPassword")
IF (nSuccess != 1)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

//  Once the SSH object is connected and authenticated, we use it
//  in our SCP object.
oScp := CreateObject("Chilkat.Scp")

nSuccess := oScp:UseSsh(oSsh)
IF (nSuccess != 1)
    ? oScp:LastErrorText
    oSsh:destroy()
    oScp:destroy()
    RETURN
ENDIF

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

cFileContents := oScp:DownloadString(cRemotePath, cCharset)
IF (oScp:LastMethodSuccess != 1)
    ? oScp:LastErrorText
    oSsh:destroy()
    oScp:destroy()
    RETURN
ENDIF

? "Received file:"
? cFileContents

? "SCP download string success."

//  Disconnect
oSsh:Disconnect()

oSsh:destroy()
oScp:destroy()