DataFlex

Download an FTP Text File into a StringBuilder

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

Background: When the remote file is text and you want its content as characters, this decodes it in one step so you can parse or display it directly. The charset must match the file's actual encoding or the text will be garbled. Like GetFileBd 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 hoFtp
    Variant vSb
    Handle hoSb
    String sFileText
    String sTemp1
    Integer iTemp1

    Move False To iSuccess

    //  Demonstrates the Ftp2.GetFileSb 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(cComChilkatFtp2)) To hoFtp
    If (Not(IsComObjectCreated(hoFtp))) Begin
        Send CreateComObject of hoFtp
    End

    Set ComHostname Of hoFtp To "ftp.example.com"
    Set ComUsername Of hoFtp To "myFtpLogin"

    //  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.
    Set ComPassword Of hoFtp To "myPassword"

    Get ComConnect Of hoFtp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoFtp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  The StringBuilder is not cleared automatically, so clear it first for replacement behavior.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSb
    If (Not(IsComObjectCreated(hoSb))) Begin
        Send CreateComObject of hoSb
    End
    Get pvComObject of hoSb to vSb
    Get ComGetFileSb Of hoFtp "public_html/data.csv" "utf-8" vSb To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoFtp 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

    Get ComDisconnect Of hoFtp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoFtp To sTemp1
        Showln sTemp1
        Procedure_Return
    End



End_Procedure