Xbase++

SFTP Simplified Download

See more SFTP Examples

Demonstrates how to SFTP download a file by passing a remote filepath to DownloadFileByName. Xbase++

LOCAL nSuccess
LOCAL oSftp
LOCAL cHostname
LOCAL nPort
LOCAL cRemoteFilePath
LOCAL cLocalFilePath

nSuccess := 0

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

oSftp := CreateObject("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.
cHostname := "sftp.example.com"
nPort := 22
nSuccess := oSftp:Connect(cHostname, nPort)
IF (nSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  Authenticate with the SSH server.  Chilkat SFTP supports
//  both password-based authenication as well as public-key
//  authentication.  This example uses password authenication.
nSuccess := oSftp:AuthenticatePw("myLogin", "myPassword")
IF (nSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  After authenticating, the SFTP subsystem must be initialized:
nSuccess := oSftp:InitializeSftp()
IF (nSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  Download the file:

cLocalFilePath := "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.
cRemoteFilePath := "subdir1/subdir2/hamlet.xml"
nSuccess := oSftp:DownloadFileByName(cRemoteFilePath, cLocalFilePath)
IF (nSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

? "Success."

oSftp:destroy()