VB.NET

Write Text to a Remote SFTP File (Sequential)

Demonstrates the Chilkat SFtp.WriteFileText method, which encodes text using a charset and writes it at the current sequential write position of an open handle. The arguments are the handle, the charset, and the text.

Background: Chilkat tracks a write position per handle, so successive WriteFileText calls append naturally — the pattern for building a file a piece at a time, such as writing rows to a report. Opening with openOrCreate starts writing at the current end of the file. The charset determines the bytes actually stored, which matters whenever the text contains non-ASCII characters.

Chilkat VB.NET Downloads

Download Chilkat for VB.NET

VB.NET

Dim success As Boolean = False

'  Demonstrates the SFtp.WriteFileText method, which encodes text and writes it at the current
'  sequential write position of an open handle.  The 1st argument is the handle, the 2nd is the
'  charset, and the 3rd is the text.

Dim sftp As New Chilkat.SFtp

'  Connect, authenticate, and initialize the SFTP subsystem.
Dim port As Integer = 22
success = sftp.Connect("sftp.example.com",port)
If (success = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


'  Normally you would not hard-code the password in source.  You should instead obtain it
'  from an interactive prompt, environment variable, or a secrets vault.
Dim password As String = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
If (success = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


success = sftp.InitializeSftp()
If (success = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


'  Open (creating/truncating) the remote file for writing.
Dim handle As String = sftp.OpenFile("subdir/notes.txt","writeOnly","createTruncate")
If (sftp.LastMethodSuccess = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


'  Write text as UTF-8.  Successive writes continue from where the previous write ended.
success = sftp.WriteFileText(handle,"utf-8","First line." & vbLf)
If (success = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If

success = sftp.WriteFileText(handle,"utf-8","Second line." & vbLf)
If (success = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


success = sftp.CloseHandle(handle)
If (success = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If

Debug.WriteLine("Wrote text file.")

sftp.Disconnect()