SFTP Download to Local Filesystem

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.

Download Chilkat SSH / SFTP ActiveX

LOCAL loSftp
LOCAL lnSuccess
LOCAL lnPort
LOCAL lcHostname
LOCAL lcHandle

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

loSftp = CreateObject('Chilkat.SFtp')

*  Any string automatically begins a fully-functional 30-day trial.

lnSuccess = loSftp.UnlockComponent("Anything for 30-day trial")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Set some timeouts, in milliseconds:
loSftp.ConnectTimeoutMs = 5000
loSftp.IdleTimeoutMs = 10000

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

lcHostname = "www.my-ssh-server.com"
lnPort = 22
lnSuccess = loSftp.Connect(lcHostname,lnPort)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Authenticate with the SSH server.  Chilkat SFTP supports
*  both password-based authenication as well as public-key
*  authentication.  This example uses password authenication.
lnSuccess = loSftp.AuthenticatePw("myLogin","myPassword")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  After authenticating, the SFTP subsystem must be initialized:
lnSuccess = loSftp.InitializeSftp()
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Open a file on the server:

lcHandle = loSftp.OpenFile("hamlet.xml","readOnly","openExisting")
IF (lcHandle = NULL ) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Download the file:
lnSuccess = loSftp.DownloadFile(lcHandle,"c:/temp/hamlet.xml")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Close the file.
lnSuccess = loSftp.CloseHandle(lcHandle)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

=MESSAGEBOX("Success.")