B4X

Upload Text to an SFTP Server (StringBuilder)

Demonstrates the Chilkat SFtp.UploadSb method, which encodes the text in a StringBuilder and uploads it to a remote file. The arguments are the StringBuilder, the remote file path, the charset, and whether to prepend a byte-order mark.

Note: This example uses relative local paths, which are resolved against the application's current working directory. Absolute local paths may also be used. Supply the paths appropriate to your own environment.

Background: This is the text-oriented upload: you assemble a document — a CSV, a config file, JSON — in a StringBuilder and the method handles character encoding as it writes. The charset controls the bytes actually stored (for example utf-8 or iso-8859-1), and the byte-order-mark flag is useful when a consuming Windows application expects a BOM. An existing destination is truncated first.

Chilkat B4X Downloads

Download Chilkat for B4X

B4X

Dim success As Boolean = False

'  Demonstrates the SFtp.UploadSb method, which encodes the text in a StringBuilder and uploads
'  it to a remote file.  The 1st argument is the StringBuilder, the 2nd is the remote file path,
'  the 3rd is the charset, and the 4th selects whether a byte-order mark is prepended.

Dim sftp As ChilkatSFtp
sftp.Initialize("sftp")

'  Connect, authenticate, and initialize the SFTP subsystem.
Dim port As Int = 22
success = sftp.Connect("sftp.example.com", port)
If success = False Then
    Log(sftp.LastErrorText)
    Return
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
    Log(sftp.LastErrorText)
    Return
End If


success = sftp.InitializeSftp
If success = False Then
    Log(sftp.LastErrorText)
    Return
End If


'  Build the text to upload.
Dim sb As ChilkatStringBuilder
sb.Initialize
sb.Append("name,quantity" & Chr(10))
sb.Append("widgets,42" & Chr(10))
sb.Append("gadgets,17" & Chr(10))

'  Upload as UTF-8 without a byte-order mark.  If the remote file exists, it is truncated first.
Dim includeBom As Boolean = False
success = sftp.UploadSb(sb, "subdir/inventory.csv", "utf-8", includeBom)
If success = False Then
    Log(sftp.LastErrorText)
    Return
End If

Log("Uploaded text file.")

sftp.Disconnect