B4X

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

Dim success As Boolean = False

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

Dim ssh As ChilkatSsh
ssh.Initialize("ssh")

'  Hostname may be an IP address or hostname:
Dim hostname As String = "www.some-ssh-server.com"
Dim port As Int = 22

'  Connect to an SSH server:
success = ssh.Connect(hostname, port)
If success <> True Then
    Log(ssh.LastErrorText)
    Return
End If


'  Wait a max of 5 seconds when reading responses..
ssh.IdleTimeoutMs = 5000

'  Authenticate using login/password:
success = ssh.AuthenticatePw("myLogin", "myPassword")
If success <> True Then
    Log(ssh.LastErrorText)
    Return
End If


'  Once the SSH object is connected and authenticated, we use it
'  in our SCP object.
Dim scp As ChilkatScp
scp.Initialize("scp")

success = scp.UseSsh(ssh)
If success <> True Then
    Log(scp.LastErrorText)
    Return
End If


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

Dim fileContents As String = scp.DownloadString(remotePath, charset)
If scp.LastMethodSuccess <> True Then
    Log(scp.LastErrorText)
    Return
End If


Log("Received file:")
Log(fileContents)

Log("SCP download string success.")

'  Disconnect
ssh.Disconnect