AutoIt

SFTP Download to Local Filesystem

See more SFTP Examples

Demonstrates how to download a file from an SSH server to the local filesystem. There are no limitations on file size, and the file is streamed directly to the local filesystem. 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 = 10000

; 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 = $oSftp.OpenFile("hamlet.xml","readOnly","openExisting")
If ($oSftp.LastMethodSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

; Download the file:
$bSuccess = $oSftp.DownloadFile($sHandle,"c:/temp/hamlet.xml")
If ($bSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

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

ConsoleWrite("Success." & @CRLF)