DataFlex

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. DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Variant vSsh
    Handle hoSsh
    String sHostname
    Integer iPort
    Handle hoScp
    String sRemotePath
    String sLocalPath
    String sTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatSsh)) To hoSsh
    If (Not(IsComObjectCreated(hoSsh))) Begin
        Send CreateComObject of hoSsh
    End

    // Hostname may be an IP address or hostname:
    Move "www.some-ssh-server.com" To sHostname
    Move 22 To iPort

    // Connect to an SSH server:
    Get ComConnect Of hoSsh sHostname iPort To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Wait a max of 5 seconds when reading responses..
    Set ComIdleTimeoutMs Of hoSsh To 5000

    // Authenticate using login/password:
    Get ComAuthenticatePw Of hoSsh "myLogin" "myPassword" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Once the SSH object is connected and authenticated, we use it
    // in our SCP object.
    Get Create (RefClass(cComChilkatScp)) To hoScp
    If (Not(IsComObjectCreated(hoScp))) Begin
        Send CreateComObject of hoScp
    End

    Get pvComObject of hoSsh to vSsh
    Get ComUseSsh Of hoScp vSsh To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoScp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // 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
    Move "testApp/logs/test1.log" To sRemotePath
    Move "c:/testApp/logs/test1.log" To sLocalPath
    Get ComDownloadFile Of hoScp sRemotePath sLocalPath To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoScp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // The following call to DownloadFile specifies an absolute file path on the SSH server:
    Move "/Users/chilkat/Documents/gecko.jpg" To sRemotePath
    Move "c:/temp/images/gecko.jpg" To sLocalPath
    Get ComDownloadFile Of hoScp sRemotePath sLocalPath To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoScp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "SCP download file success."

    // Disconnect
    Send ComDisconnect To hoSsh


End_Procedure