AutoIt

SFTP Simplified Download

See more SFTP Examples

Demonstrates how to SFTP download a file by passing a remote filepath to DownloadFileByName. 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 = 15000
$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

;  Download the file:
Local $sRemoteFilePath
Local $sLocalFilePath
$sLocalFilePath = "c:/temp/hamlet.xml"
;  Note: The remote filepath may be an absolute filepath,
;  a relative filepath, or simply a filename.  
;  Relative filepaths are always relative to the home directory
;  of the SFTP/SSH user account.  There is no such thing
;  as "current remote directory" in the SFTP protocol. 
;  A filename with no path implies that the file is located
;  in the SFTP user account's home directory.
$sRemoteFilePath = "subdir1/subdir2/hamlet.xml"
$bSuccess = $oSftp.DownloadFileByName($sRemoteFilePath,$sLocalFilePath)
If ($bSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("Success." & @CRLF)