DataFlex

SCP Download Text File to String Variable

See more SCP Examples

Downloads a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server directly into a string variable. DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Variant vSsh
    Handle hoSsh
    String sHostname
    Integer iPort
    Handle hoScp
    String sRemotePath
    String sCharset
    String sFileContents
    String sTemp1
    Boolean bTemp1

    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 "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).  
    Move "repository/xml/hamlet.xml" To sRemotePath

    // The byte representation of the remote text file (i.e. the charset) must be
    // indicated to allow the receiving software to correctly interpret the incoming
    // bytes as the correct chars.
    // See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charset names.
    Move "utf-8" To sCharset

    Get ComDownloadString Of hoScp sRemotePath sCharset To sFileContents
    Get ComLastMethodSuccess Of hoScp To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoScp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "Received file:"
    Showln sFileContents

    Showln "SCP download string success."

    // Disconnect
    Send ComDisconnect To hoSsh


End_Procedure