VBScript

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 VBScript Downloads

Download Chilkat for VBScript

VBScript

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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.

set sftp = CreateObject("Chilkat.SFtp")

'  Connect, authenticate, and initialize the SFTP subsystem.
port = 22
success = sftp.Connect("sftp.example.com",port)
If (success = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
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.
password = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
If (success = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

success = sftp.InitializeSftp()
If (success = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

handle = sftp.OpenFile("subdir/image.png","readOnly","openExisting")
If (sftp.LastMethodSuccess = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

'  Read the file in chunks until end-of-file, accumulating the bytes in a BinData.
set bd = CreateObject("Chilkat.BinData")
chunkSize = 8192
reading = 1
Do While reading
    success = sftp.ReadFileBd(handle,chunkSize,bd)
    If (sftp.LastReadFailed(handle)) Then
        outFile.WriteLine(sftp.LastErrorText)
        WScript.Quit
    End If

    reading = Not sftp.Eof(handle)
Loop

success = sftp.CloseHandle(handle)
If (success = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

outFile.WriteLine("Read " & bd.NumBytes & " bytes.")

sftp.Disconnect 

outFile.Close