VBScript

SFTP Read Text File to String

See more SFTP Examples

Demonstrates how to download a text file from an SSH server directly into a string variable. 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

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

set sftp = CreateObject("Chilkat.SFtp")

' 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 = "sftp.example.com"
port = 22
success = sftp.Connect(hostname,port)
If (success <> 1) Then
    outFile.WriteLine(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
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

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

' Open a file on the server:

handle = sftp.OpenFile("hamlet.xml","readOnly","openExisting")
If (sftp.LastMethodSuccess <> 1) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

' Get the total size of this file (in bytes)
bFollowLinks = 0
bIsHandle = 1

' bFollowLinks is ignored because we are passing a handle
' and not a remote filename.
' There are alternative methods for handling file sizes
' greater than 32-bit.  (See the reference documentation.)
numBytes = sftp.GetFileSize32(handle,bFollowLinks,bIsHandle)
If (numBytes < 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

' The charset indicates the character encoding of the text
' file on the SSH server.   Setting the charset correctly
' allows the Chilkat SFTP component to correctly interpret
' the bytes that represent the characters.

charset = "ansi"

fileContents = sftp.ReadFileText(handle,numBytes,charset)
If (sftp.LastMethodSuccess <> 1) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
Else
    outFile.WriteLine("Received file:")
    outFile.WriteLine(fileContents)
End If

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

outFile.WriteLine("Success.")

outFile.Close