(Xojo Plugin) SCP Download from a Specific Directory

Demonstrates how to download a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server. The remote directory can be a path relative to the HOME directory of the SSH user account, or an absolute path on the remote filesystem. Obviously, in both cases the SSH user account must have permission to open and read the file in the specified directory.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim ssh As New Chilkat.Ssh

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

// Connect to an SSH server:
Dim success As Boolean
success = ssh.Connect(hostname,port)
If (success <> True) Then
    System.DebugLog(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
    System.DebugLog(ssh.LastErrorText)
    Return
End If

// Once the SSH object is connected and authenticated, we use it
// in our SCP object.
Dim scp As New Chilkat.Scp

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

// This downloads a file from the "testApp/logs/" subdirectory (relative to the SSH user account's HOME directory).  
// For example, if the HOME directory is /Users/chilkat, then the following downloads
// /Users/chilkat/testApp/logs/test1.log
Dim remotePath As String
remotePath = "testApp/logs/test1.log"
Dim localPath As String
localPath = "c:/testApp/logs/test1.log"
success = scp.DownloadFile(remotePath,localPath)
If (success <> True) Then
    System.DebugLog(scp.LastErrorText)
    Return
End If

// The following call to DownloadFile specifies an absolute file path on the SSH server:
remotePath = "/Users/chilkat/Documents/gecko.jpg"
localPath = "c:/temp/images/gecko.jpg"
success = scp.DownloadFile(remotePath,localPath)
If (success <> True) Then
    System.DebugLog(scp.LastErrorText)
    Return
End If

System.DebugLog("SCP download file success.")

// Disconnect
ssh.Disconnect