Xbase++

SCP Upload Contents of String to Remote File

See more SCP Examples

Demonstrates how to upload the contents of a string variable using the SCP protocol (Secure Copy Protocol over SSH). The text is uploaded to a file in specific remote directory. If the file did not already exist, it is created. If it already existed, it is overwritten. Xbase++

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

nSuccess := 0

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

oSsh := CreateObject("Chilkat.Ssh")

//  Connect to an SSH server:

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

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
//  as the underlying transport in our SCP object.
oScp := CreateObject("Chilkat.Scp")

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

cContent := "This string will be the contents of the remote file."
cRemotePath := "uploads/text/testUtf8.txt"

//  The utf-8 byte representation of the string will be uploaded.
//  See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charsets.
cCharset := "utf-8"

//  This uploads to the "uploads/text" directory relative to the HOME
//  directory of the SSH user account.  
//  Note: The remote target directory must already exist on the SSH server.
nSuccess := oScp:UploadString(cRemotePath, cContent, cCharset)
IF (nSuccess != 1)
    ? oScp:LastErrorText
    oSsh:destroy()
    oScp:destroy()
    RETURN
ENDIF

cRemotePath := "uploads/text/testUtf8_withBOM.txt"

//  To include the utf-8 preamble (also known as the BOM),
//  prefix the charset name with "bom:".  Any charset that can 
//  optionally include a BOM can be specified in this way.
cCharset := "bom:utf-8"

//  Uploads to a remote file that contains text in the 
//  utf-8 representation, including the BOM at the start of the file.
nSuccess := oScp:UploadString(cRemotePath, cContent, cCharset)
IF (nSuccess != 1)
    ? oScp:LastErrorText
    oSsh:destroy()
    oScp:destroy()
    RETURN
ENDIF

? "SCP upload string success."

//  Disconnect
oSsh:Disconnect()

oSsh:destroy()
oScp:destroy()