(VB.NET) 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 .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

' 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 = "sftp.example.com"
Dim port As Integer = 22
Dim success As Boolean = sftp.Connect(hostname,port)
If (success <> True) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
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
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


' After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
If (success <> True) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


' Open a file on the server:
Dim handle As String = sftp.OpenFile("hamlet.xml","readOnly","openExisting")
If (sftp.LastMethodSuccess <> True) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


' Download the file:
success = sftp.DownloadFile(handle,"c:/temp/hamlet.xml")
If (success <> True) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


' Close the file.
success = sftp.CloseHandle(handle)
If (success <> True) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


Debug.WriteLine("Success.")