PureBasic

Download Bytes from an SFTP Server (BinData)

Demonstrates the Chilkat SFtp.DownloadBd method, which downloads a remote file and appends its bytes to a BinData. The first argument is the remote file path and the second is the BinData.

Note: This example uses relative local paths, which are resolved against the application's current working directory. Absolute local paths may also be used. Supply the paths appropriate to your own environment.

Background: This brings a remote file straight into memory for hashing, parsing, or handing to another API, with no temporary file on disk. Because it appends, existing bytes in the BinData are preserved — convenient for concatenating several remote files, but a source of surprise if you expected replacement, so clear the BinData first when you want only this file's contents.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkBinData.pb"
IncludeFile "CkSFtp.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the SFtp.DownloadBd method, which downloads a remote file and appends its bytes
    ;  to a BinData.  The 1st argument is the remote file path and the 2nd is the BinData.

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

    ;  Connect, authenticate, and initialize the SFTP subsystem.
    port.i = 22
    success = CkSFtp::ckConnect(sftp,"sftp.example.com",port)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ;  Normally you would not hard-code the password in source.  You should instead obtain it
    ;  from an interactive prompt, environment variable, or a secrets vault.
    password.s = "mySshPassword"

    success = CkSFtp::ckAuthenticatePw(sftp,"mySshLogin",password)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    success = CkSFtp::ckInitializeSftp(sftp)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ;  Download the remote file's bytes into a BinData.  Existing bytes in the BinData are
    ;  preserved, so clear it first if you want replacement rather than append behavior.
    bd.i = CkBinData::ckCreate()
    If bd.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkSFtp::ckDownloadBd(sftp,"subdir/image.png",bd)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        CkBinData::ckDispose(bd)
        ProcedureReturn
    EndIf

    Debug "Downloaded " + Str(CkBinData::ckNumBytes(bd)) + " bytes."

    CkSFtp::ckDisconnect(sftp)


    CkSFtp::ckDispose(sftp)
    CkBinData::ckDispose(bd)


    ProcedureReturn
EndProcedure