AutoIt

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. AutoIt

Local $bSuccess = False

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

$oSftp = ObjCreate("Chilkat.SFtp")

; Set some timeouts, in milliseconds:
$oSftp.ConnectTimeoutMs = 5000
$oSftp.IdleTimeoutMs = 15000

; Connect to the SSH server.  
; The standard SSH port = 22
; The hostname may be a hostname or IP address.
Local $sHostname = "sftp.example.com"
Local $iPort = 22
$bSuccess = $oSftp.Connect($sHostname,$iPort)
If ($bSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

; Authenticate with the SSH server.  Chilkat SFTP supports
; both password-based authenication as well as public-key
; authentication.  This example uses password authenication.
$bSuccess = $oSftp.AuthenticatePw("myLogin","myPassword")
If ($bSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

; After authenticating, the SFTP subsystem must be initialized:
$bSuccess = $oSftp.InitializeSftp()
If ($bSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

; Open a file on the server:
Local $sHandle
$sHandle = $oSftp.OpenFile("hamlet.xml","readOnly","openExisting")
If ($oSftp.LastMethodSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

; Get the total size of this file (in bytes)
Local $bFollowLinks = False
Local $bIsHandle = True
Local $iNumBytes

; 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.)
$iNumBytes = $oSftp.GetFileSize32($sHandle,$bFollowLinks,$bIsHandle)
If ($iNumBytes < 0) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

; 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.
Local $sCharset
$sCharset = "ansi"
Local $sFileContents
$sFileContents = $oSftp.ReadFileText($sHandle,$iNumBytes,$sCharset)
If ($oSftp.LastMethodSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
Else
    ConsoleWrite("Received file:" & @CRLF)
    ConsoleWrite($sFileContents & @CRLF)
EndIf

; Close the file.
$bSuccess = $oSftp.CloseHandle($sHandle)
If ($bSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("Success." & @CRLF)