SFTP Read Text File

Demonstrates how to open a text file on the SSH server and read text.

Download Chilkat SSH / SFTP ActiveX

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
Set outFile = fso.CreateTextFile("output.txt", True)

'  Important: It is helpful to send the contents of the
'  sftp.LastErrorText property when requesting support.

set sftp = CreateObject("Chilkat.SFtp")

'  Any string automatically begins a fully-functional 30-day trial.
success = sftp.UnlockComponent("Anything for 30-day trial")
If (success <> 1) Then
    MsgBox sftp.LastErrorText
    WScript.Quit
End If

'  Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs = 5000
sftp.IdleTimeoutMs = 15000

'  Connect to the SSH server.
'  The standard SSH port = 22
'  The hostname may be a hostname or IP address.

hostname = "www.my-ssh-server.com"
port = 22
success = sftp.Connect(hostname,port)
If (success <> 1) Then
    MsgBox sftp.LastErrorText
    WScript.Quit
End If

'  Authenticate with the SSH server.  Chilkat SFTP supports
'  both password-based authenication as well as public-key
'  authentication.  This example uses password authenication.
success = sftp.AuthenticatePw("myLogin","myPassword")
If (success <> 1) Then
    MsgBox sftp.LastErrorText
    WScript.Quit
End If

'  After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
If (success <> 1) Then
    MsgBox sftp.LastErrorText
    WScript.Quit
End If

'  Open a file for reading.

handle = sftp.OpenFile("myTest.txt","readOnly","openExisting")
If (handle = vbNullString ) Then
    MsgBox sftp.LastErrorText
    WScript.Quit
End If

'  Assume the file we are reading contains the following text:
'  abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
'  (in ANSI format -- i.e. one byte per char).

'  Read 26 bytes:

sText = sftp.ReadFileText(handle,26,"ansi")
If (success <> 1) Then
    MsgBox sftp.LastErrorText
    WScript.Quit
End If

'  Should print "abcdefghijklmnopqrstuvwxyz"
outFile.WriteLine(sText)

'  Read the next 10 bytes.
sText = sftp.ReadFileText(handle,10,"ansi")
If (success <> 1) Then
    MsgBox sftp.LastErrorText
    WScript.Quit
End If

'  Should print "1234567890"
outFile.WriteLine(sText)

'  Read the next 26 bytes.
sText = sftp.ReadFileText(handle,26,"ansi")
If (success <> 1) Then
    MsgBox sftp.LastErrorText
    WScript.Quit
End If

'  Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
outFile.WriteLine(sText)

'  Close the file.
success = sftp.CloseHandle(handle)
If (success <> 1) Then
    MsgBox sftp.LastErrorText
    WScript.Quit
End If

MsgBox "Success."
outFile.Close