SFTP Writing utf-8 vs. ANSI Text Files

Demonstrates how to specify the charset, such as utf-8, ANSI, windows-1250, iso-8859-1, Shift_JIS, etc., when writing text files. See the List of Charsets for all supported charsets.

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 = "192.168.1.108"
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 on the server for writing.
'  "createTruncate" means that a new file is created; if the file already exists, it is opened and truncated.
Dim handle As String
handle = sftp.OpenFile("utf8_sample.txt","writeOnly","createTruncate")
If (handle = vbNullString ) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


'  Write a single utf-8 character to the file - a lowercase ü
'  A "ü" in utf-8 is represented by 2 bytes:  0xC3 0xBC
'  The following call to WriteFileText writes 2 bytes (0xC3 0xBC)
'  to the file:
success = sftp.WriteFileText(handle,"utf-8","ü")
If (success <> true) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


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


'  Let's write the same "ü" character using windows-1252
'  (which is the ANSI charset for Western-European languages)
handle = sftp.OpenFile("windows1252_sample.txt","writeOnly","createTruncate")
If (handle = vbNullString ) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


'  Write a single windows-1252 character to the file - a lowercase ü
'  A "ü" in windows-1252 is represented by 1 byte:  0xFC
'  The following call to WriteFileText writes 1 byte (0xFC)
'  to the file:
success = sftp.WriteFileText(handle,"windows-1252","ü")
If (success <> true) Then
    MsgBox(sftp.LastErrorText)
    Exit Sub
End If


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


MsgBox("Success.")