Visual Basic 6.0

Get the Byte Count of the Last SFTP Read

Demonstrates the Chilkat SFtp.LastReadNumBytes method, which returns the number of bytes received by the most recent read for a handle. The only argument is the handle.

Background: SFTP reads may return fewer bytes than requested even before the end of the file, so knowing the actual count is useful for tracking progress and for advancing an explicit offset by the right amount. Both a normal EOF read and a failed read report 0, so pair this with Eof and LastReadFailed to interpret a zero-byte result correctly.

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.LastReadNumBytes method, which returns the number of bytes received by
'  the most recent read for a handle.  The only argument is the handle.

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/data.txt","readOnly","openExisting")
If (sftp.LastMethodSuccess = 0) Then
    Debug.Print sftp.LastErrorText
    Exit Sub
End If

Dim bd As New ChilkatBinData
Dim chunkSize As Long
chunkSize = 4096
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

    '  Report how many bytes the last read actually returned.  A normal EOF read reports 0.
    Dim lastCount As Long
    lastCount = sftp.LastReadNumBytes(handle)
    Debug.Print "Last read returned " & lastCount & " bytes."

    reading = Not sftp.Eof(handle)
Loop

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

Debug.Print "Total: " & bd.NumBytes & " bytes."

sftp.Disconnect