Visual Basic 6.0

Read Bytes from a Remote SFTP File (BinData)

Demonstrates the Chilkat SFtp.ReadFileBd method, which reads up to a number of bytes from the current position of an open handle and appends them to a BinData. The arguments are the handle, the maximum number of bytes, and the BinData. This example reads in chunks until end-of-file.

Background: For binary files, reading into a BinData preserves the bytes exactly, unlike a text read that decodes through a charset. Because it appends, the chunked read loop accumulates the whole file in the BinData; each pass reads up to the chunk size and the loop repeats until Eof. Fewer bytes than requested can come back near the end of the file, which is normal.

Chilkat Visual Basic 6.0 Downloads

Download Chilkat for Visual Basic 6.0

Visual Basic 6.0

Dim success As Long
success = 0

'  Demonstrates the SFtp.ReadFileBd method, which reads up to a number of bytes from the current
'  position of an open handle and appends them to a BinData.  The 1st argument is the handle, the
'  2nd is the maximum number of bytes, and the 3rd is the BinData.

Dim sftp As New ChilkatSFtp

'  Connect, authenticate, and initialize the SFTP subsystem.
Dim port As Long
port = 22
success = sftp.Connect("sftp.example.com",port)
If (success = 0) Then
    Debug.Print 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
password = "mySshPassword"

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

success = sftp.InitializeSftp()
If (success = 0) Then
    Debug.Print sftp.LastErrorText
    Exit Sub
End If

Dim handle As String
handle = sftp.OpenFile("subdir/image.png","readOnly","openExisting")
If (sftp.LastMethodSuccess = 0) Then
    Debug.Print sftp.LastErrorText
    Exit Sub
End If

'  Read the file in chunks until end-of-file, accumulating the bytes in a BinData.
Dim bd As New ChilkatBinData
Dim chunkSize As Long
chunkSize = 8192
Dim reading As Long
reading = 1
Do While reading
    success = sftp.ReadFileBd(handle,chunkSize,bd)
    If (sftp.LastReadFailed(handle)) Then
        Debug.Print sftp.LastErrorText
        Exit Sub
    End If

    reading = Not sftp.Eof(handle)
Loop

success = sftp.CloseHandle(handle)
If (success = 0) Then
    Debug.Print sftp.LastErrorText
    Exit Sub
End If

Debug.Print "Read " & bd.NumBytes & " bytes."

sftp.Disconnect