(Xojo Plugin) SFTP Download to Local Filesystem

Demonstrates how to download a file from an SSH server to the local filesystem. There are no limitations on file size, and the file is streamed directly to the local filesystem.

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

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

Dim sftp As New Chilkat.SFtp

// Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs = 5000
sftp.IdleTimeoutMs = 10000

// Connect to the SSH server.  
// The standard SSH port = 22
// The hostname may be a hostname or IP address.
Dim hostname As String
hostname = "sftp.example.com"
Dim port As Int32
port = 22
Dim success As Boolean
success = sftp.Connect(hostname,port)
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// Authenticate with the SSH server.  Chilkat SFTP supports
// both password-based authenication as well as public-key
// authentication.  This example uses password authenication.
success = sftp.AuthenticatePw("myLogin","myPassword")
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// Open a file on the server:
Dim handle As String
handle = sftp.OpenFile("hamlet.xml","readOnly","openExisting")
If (sftp.LastMethodSuccess <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// Download the file:
success = sftp.DownloadFile(handle,"c:/temp/hamlet.xml")
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// Close the file.
success = sftp.CloseHandle(handle)
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

System.DebugLog("Success.")