Visual FoxPro

SFTP Simplified Download

See more SFTP Examples

Demonstrates how to SFTP download a file by passing a remote filepath to DownloadFileByName. Visual FoxPro

LOCAL lnSuccess
LOCAL loSftp
LOCAL lcHostname
LOCAL lnPort
LOCAL lcRemoteFilePath
LOCAL lcLocalFilePath

lnSuccess = 0

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

loSftp = CreateObject('Chilkat.SFtp')

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

* Connect to the SSH server.  
* The standard SSH port = 22
* The hostname may be a hostname or IP address.
lcHostname = "sftp.example.com"
lnPort = 22
lnSuccess = loSftp.Connect(lcHostname,lnPort)
IF (lnSuccess <> 1) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
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
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
ENDIF

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

* Download the file:

lcLocalFilePath = "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.
lcRemoteFilePath = "subdir1/subdir2/hamlet.xml"
lnSuccess = loSftp.DownloadFileByName(lcRemoteFilePath,lcLocalFilePath)
IF (lnSuccess <> 1) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
ENDIF

? "Success."

RELEASE loSftp