(Visual FoxPro) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loSsh
LOCAL lcHostname
LOCAL lnPort
LOCAL lnSuccess
LOCAL loScp
LOCAL lcRemotePath
LOCAL lcCharset
LOCAL lcFileContents

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Ssh')
loSsh = CreateObject('Chilkat.Ssh')

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

* Connect to an SSH server:
lnSuccess = loSsh.Connect(lcHostname,lnPort)
IF (lnSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
ENDIF

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

* Authenticate using login/password:
lnSuccess = loSsh.AuthenticatePw("myLogin","myPassword")
IF (lnSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
ENDIF

* Once the SSH object is connected and authenticated, we use it
* in our SCP object.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Scp')
loScp = CreateObject('Chilkat.Scp')

lnSuccess = loScp.UseSsh(loSsh)
IF (lnSuccess <> 1) THEN
    ? loScp.LastErrorText
    RELEASE loSsh
    RELEASE loScp
    CANCEL
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 <> 1) THEN
    ? loScp.LastErrorText
    RELEASE loSsh
    RELEASE loScp
    CANCEL
ENDIF

? "Received file:"
? lcFileContents

? "SCP download string success."

* Disconnect
loSsh.Disconnect()

RELEASE loSsh
RELEASE loScp