PowerBuilder

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. PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Ssh
string ls_Hostname
integer li_Port
oleobject loo_Scp
string ls_Content
string ls_RemotePath
string ls_Charset

li_Success = 0

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

loo_Ssh = create oleobject
li_rc = loo_Ssh.ConnectToNewObject("Chilkat.Ssh")
if li_rc < 0 then
    destroy loo_Ssh
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Connect to an SSH server:

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

li_Success = loo_Ssh.Connect(ls_Hostname,li_Port)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

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

// Authenticate using login/password:
li_Success = loo_Ssh.AuthenticatePw("myLogin","myPassword")
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

// Once the SSH object is connected and authenticated, we use it
// as the underlying transport in our SCP object.
loo_Scp = create oleobject
li_rc = loo_Scp.ConnectToNewObject("Chilkat.Scp")

li_Success = loo_Scp.UseSsh(loo_Ssh)
if li_Success <> 1 then
    Write-Debug loo_Scp.LastErrorText
    destroy loo_Ssh
    destroy loo_Scp
    return
end if

ls_Content = "This string will be the contents of the remote file."
ls_RemotePath = "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.
ls_Charset = "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.
li_Success = loo_Scp.UploadString(ls_RemotePath,ls_Content,ls_Charset)
if li_Success <> 1 then
    Write-Debug loo_Scp.LastErrorText
    destroy loo_Ssh
    destroy loo_Scp
    return
end if

ls_RemotePath = "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.
ls_Charset = "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.
li_Success = loo_Scp.UploadString(ls_RemotePath,ls_Content,ls_Charset)
if li_Success <> 1 then
    Write-Debug loo_Scp.LastErrorText
    destroy loo_Ssh
    destroy loo_Scp
    return
end if

Write-Debug "SCP upload string success."

// Disconnect
loo_Ssh.Disconnect()


destroy loo_Ssh
destroy loo_Scp