SFTP Read Text File

Demonstrates how to open a text file on the SSH server and read text.

Download Chilkat .NET for 2.0 / 3.5 Framework

Download Chilkat .NET for 64-bit 2.0 / 3.5 Framework (x64)

Download Chilkat .NET for 1.0 / 1.1 Framework

'  Important: It is helpful to send the contents of the
'  sftp.LastErrorText property when requesting support.

Dim sftp As New Chilkat.SFtp()

'  Any string automatically begins a fully-functional 30-day trial.
Dim success As Boolean
success = sftp.UnlockComponent("Anything for 30-day trial")
If (success <> true) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


'  Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs = 5000
sftp.IdleTimeoutMs = 15000

'  Connect to the SSH server.
'  The standard SSH port = 22
'  The hostname may be a hostname or IP address.
Dim port As Long
Dim hostname As String
hostname = "www.my-ssh-server.com"
port = 22
success = sftp.Connect(hostname,port)
If (success <> true) Then
    MsgBox(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
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


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


'  Open a file for reading.
Dim handle As String
handle = sftp.OpenFile("myTest.txt","readOnly","openExisting")
If (handle = vbNullString ) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


'  Assume the file we are reading contains the following text:
'  abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
'  (in ANSI format -- i.e. one byte per char).

'  Read 26 bytes:
Dim sText As String
sText = sftp.ReadFileText(handle,26,"ansi")
If (success <> true) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


'  Should print "abcdefghijklmnopqrstuvwxyz"
TextBox1.Text = TextBox1.Text & sText & vbCrLf

'  Read the next 10 bytes.
sText = sftp.ReadFileText(handle,10,"ansi")
If (success <> true) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


'  Should print "1234567890"
TextBox1.Text = TextBox1.Text & sText & vbCrLf

'  Read the next 26 bytes.
sText = sftp.ReadFileText(handle,26,"ansi")
If (success <> true) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


'  Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
TextBox1.Text = TextBox1.Text & sText & vbCrLf

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


MsgBox("Success.")