PureBasic

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

IncludeFile "CkSsh.pb"
IncludeFile "CkScp.pb"

Procedure ChilkatExample()

    success.i = 0

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

    ssh.i = CkSsh::ckCreate()
    If ssh.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Hostname may be an IP address or hostname:
    hostname.s = "www.some-ssh-server.com"
    port.i = 22

    ; Connect to an SSH server:
    success = CkSsh::ckConnect(ssh,hostname,port)
    If success <> 1
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    ; Wait a max of 5 seconds when reading responses..
    CkSsh::setCkIdleTimeoutMs(ssh, 5000)

    ; Authenticate using login/password:
    success = CkSsh::ckAuthenticatePw(ssh,"myLogin","myPassword")
    If success <> 1
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    ; Once the SSH object is connected and authenticated, we use it
    ; in our SCP object.
    scp.i = CkScp::ckCreate()
    If scp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkScp::ckUseSsh(scp,ssh)
    If success <> 1
        Debug CkScp::ckLastErrorText(scp)
        CkSsh::ckDispose(ssh)
        CkScp::ckDispose(scp)
        ProcedureReturn
    EndIf

    ; This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).  
    remotePath.s = "repository/xml/hamlet.xml"

    ; 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.
    charset.s = "utf-8"

    fileContents.s = CkScp::ckDownloadString(scp,remotePath,charset)
    If CkScp::ckLastMethodSuccess(scp) <> 1
        Debug CkScp::ckLastErrorText(scp)
        CkSsh::ckDispose(ssh)
        CkScp::ckDispose(scp)
        ProcedureReturn
    EndIf

    Debug "Received file:"
    Debug fileContents

    Debug "SCP download string success."

    ; Disconnect
    CkSsh::ckDisconnect(ssh)


    CkSsh::ckDispose(ssh)
    CkScp::ckDispose(scp)


    ProcedureReturn
EndProcedure