Xbase++

SCP Download from a Specific Directory

See more SCP Examples

Demonstrates how to download a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server. The remote directory can be a path relative to the HOME directory of the SSH user account, or an absolute path on the remote filesystem. Obviously, in both cases the SSH user account must have permission to open and read the file in the specified directory. Xbase++

LOCAL nSuccess
LOCAL oSsh
LOCAL cHostname
LOCAL nPort
LOCAL oScp
LOCAL cRemotePath
LOCAL cLocalPath

nSuccess := 0

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

oSsh := CreateObject("Chilkat.Ssh")

//  Hostname may be an IP address or hostname:
cHostname := "www.some-ssh-server.com"
nPort := 22

//  Connect to an SSH server:
nSuccess := oSsh:Connect(cHostname, nPort)
IF (nSuccess != 1)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

//  Wait a max of 5 seconds when reading responses..
oSsh:IdleTimeoutMs := 5000

//  Authenticate using login/password:
nSuccess := oSsh:AuthenticatePw("myLogin", "myPassword")
IF (nSuccess != 1)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

//  Once the SSH object is connected and authenticated, we use it
//  in our SCP object.
oScp := CreateObject("Chilkat.Scp")

nSuccess := oScp:UseSsh(oSsh)
IF (nSuccess != 1)
    ? oScp:LastErrorText
    oSsh:destroy()
    oScp:destroy()
    RETURN
ENDIF

//  This downloads a file from the "testApp/logs/" subdirectory (relative to the SSH user account's HOME directory).  
//  For example, if the HOME directory is /Users/chilkat, then the following downloads
//  /Users/chilkat/testApp/logs/test1.log
cRemotePath := "testApp/logs/test1.log"
cLocalPath := "c:/testApp/logs/test1.log"
nSuccess := oScp:DownloadFile(cRemotePath, cLocalPath)
IF (nSuccess != 1)
    ? oScp:LastErrorText
    oSsh:destroy()
    oScp:destroy()
    RETURN
ENDIF

//  The following call to DownloadFile specifies an absolute file path on the SSH server:
cRemotePath := "/Users/chilkat/Documents/gecko.jpg"
cLocalPath := "c:/temp/images/gecko.jpg"
nSuccess := oScp:DownloadFile(cRemotePath, cLocalPath)
IF (nSuccess != 1)
    ? oScp:LastErrorText
    oSsh:destroy()
    oScp:destroy()
    RETURN
ENDIF

? "SCP download file success."

//  Disconnect
oSsh:Disconnect()

oSsh:destroy()
oScp:destroy()