DataFlex

Download Text from an SFTP Server (StringBuilder)

Demonstrates the Chilkat SFtp.DownloadSb method, which downloads a remote text file, decodes it with the given charset, and appends the text to a StringBuilder. The arguments are the remote file path, the charset, and the StringBuilder.

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: When the remote file is text and you want its content as characters rather than raw bytes, this decodes it in one step so you can parse or display it directly. The charset must match how the file is actually encoded, or the text will be garbled. Like DownloadBd it appends, so clear the StringBuilder first if you want only this file's text.

Chilkat DataFlex Downloads

Download Chilkat for DataFlex

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoSftp
    Integer iPort
    String sPassword
    Variant vSb
    Handle hoSb
    String sFileText
    String sTemp1
    Integer iTemp1

    Move False To iSuccess

    //  Demonstrates the SFtp.DownloadSb method, which downloads a remote text file, decodes it, and
    //  appends the text to a StringBuilder.  The 1st argument is the remote file path, the 2nd is the
    //  charset, and the 3rd is the StringBuilder.

    Get Create (RefClass(cComChilkatSFtp)) To hoSftp
    If (Not(IsComObjectCreated(hoSftp))) Begin
        Send CreateComObject of hoSftp
    End

    //  Connect, authenticate, and initialize the SFTP subsystem.
    Move 22 To iPort
    Get ComConnect Of hoSftp "sftp.example.com" iPort To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  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.
    Move "mySshPassword" To sPassword

    Get ComAuthenticatePw Of hoSftp "mySshLogin" sPassword To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComInitializeSftp Of hoSftp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  Download the remote text file, decoding it as UTF-8.  Existing text in the StringBuilder is
    //  preserved, so clear it first if you want replacement rather than append behavior.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSb
    If (Not(IsComObjectCreated(hoSb))) Begin
        Send CreateComObject of hoSb
    End
    Get pvComObject of hoSb to vSb
    Get ComDownloadSb Of hoSftp "subdir/inventory.csv" "utf-8" vSb To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComLength Of hoSb To iTemp1
    Showln "Characters downloaded: " iTemp1
    Get ComGetAsString Of hoSb To sFileText
    Showln sFileText

    Send ComDisconnect To hoSftp


End_Procedure