B4X

Write Bytes to a Remote SFTP File (BinData)

Demonstrates the Chilkat SFtp.WriteFileBd method, which appends all bytes in a BinData to the remote file identified by an open handle. The first argument is the handle and the second is the BinData.

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

Background: This is the binary counterpart to WriteFileText — the right choice for images, archives, or any non-text content, where a charset conversion would corrupt the data. Combined with an appropriate OpenFile disposition it can create, overwrite, or append; here the file is created/truncated first so the result is exactly the BinData contents.

Chilkat B4X Downloads

Download Chilkat for B4X

B4X

Dim success As Boolean = False

'  Demonstrates the SFtp.WriteFileBd method, which appends all bytes in a BinData to the remote
'  file identified by an open handle.  The 1st argument is the handle and the 2nd is the BinData.

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


'  Open (creating/truncating) the remote file for writing.
Dim handle As String = sftp.OpenFile("subdir/image.png", "writeOnly", "createTruncate")
If sftp.LastMethodSuccess = False Then
    Log(sftp.LastErrorText)
    Return
End If


'  Put the bytes to write into a BinData.  (Here they are loaded from a local file, but the
'  bytes could come from anywhere.)
Dim bd As ChilkatBinData
bd.Initialize
success = bd.LoadFile("qa_data/image.png")
If success = False Then
    Log(bd.LastErrorText)
    Return
End If


'  Append the BinData bytes to the open remote file.
success = sftp.WriteFileBd(handle, bd)
If success = False Then
    Log(sftp.LastErrorText)
    Return
End If


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

Log("Wrote " & bd.NumBytes & " bytes.")

sftp.Disconnect