PureBasic

FTP Download Text File to a Stream

See more FTP Examples

Demonstrates how to FTP download a text file to a Chilkat stream.

Note: This example requires Chilkat v9.5.0.67 or greater.

PureBasic

IncludeFile "CkFtp2.pb"
IncludeFile "CkTask.pb"
IncludeFile "CkStream.pb"

Procedure ChilkatExample()

    success.i = 0

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

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

    CkFtp2::setCkHostname(ftp, "www.my-ftp-server.com")
    CkFtp2::setCkUsername(ftp, "mFtpLogin")
    CkFtp2::setCkPassword(ftp, "myFtpPassword")
    CkFtp2::setCkAuthTls(ftp, 1)
    CkFtp2::setCkPassive(ftp, 1)

    ; Connect and login to the FTP server using TLS.
    success = CkFtp2::ckConnect(ftp)
    If success <> 1
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

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

    ; Indicate the charset of the incoming data.
    CkStream::setCkStringCharset(streamObj, "utf-8")

    ; Create a task to do the FTP download.
    t.i = CkFtp2::ckGetFileToStreamAsync(ftp,"lines.txt",streamObj)
    If CkFtp2::ckLastMethodSuccess(ftp) <> 1
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        CkStream::ckDispose(streamObj)
        ProcedureReturn
    EndIf

    ; Start the task in a background thread.
    CkTask::ckRun(t)

    ; Read the incoming text data using any of the streamObj Read methods.
    ; This example will read line-by-line.
    line.s
    While CkStream::ckEndOfStream(streamObj) <> 1
        line = CkStream::ckReadToCRLF(streamObj)
        If CkStream::ckLastMethodSuccess(streamObj) = 1
            Debug line
        EndIf

    Wend
    CkTask::ckDispose(t)

    Debug "Success."


    CkFtp2::ckDispose(ftp)
    CkStream::ckDispose(streamObj)


    ProcedureReturn
EndProcedure