PureBasic

FTP Download Binary File to a Stream

See more FTP Examples

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

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

PureBasic

IncludeFile "CkFtp2.pb"
IncludeFile "CkBinData.pb"
IncludeFile "CkTask.pb"
IncludeFile "CkStream.pb"
IncludeFile "CkFileAccess.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

    ; We'll read the incoming data chunk-by-chunk and write to an output file.
    fac.i = CkFileAccess::ckCreate()
    If fac.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkFileAccess::ckOpenForWrite(fac,"qa_output/penguins2.jpg")
    If success <> 1
        Debug CkFileAccess::ckLastErrorText(fac)
        CkFtp2::ckDispose(ftp)
        CkFileAccess::ckDispose(fac)
        ProcedureReturn
    EndIf

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

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

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

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

    While CkStream::ckEndOfStream(streamObj) <> 1
        ; Get the next chunk of JPG bytes.
        CkStream::ckReadBd(streamObj,bd)
        ; Do something with it..
        ; In this simple example, we'll just write to the file.
        CkFileAccess::ckFileWriteBd(fac,bd,0,0)
        ; Clear for the next read.
        CkBinData::ckClear(bd)
    Wend

    CkFileAccess::ckFileClose(fac)

    CkTask::ckDispose(t)

    Debug "Success."


    CkFtp2::ckDispose(ftp)
    CkFileAccess::ckDispose(fac)
    CkStream::ckDispose(streamObj)
    CkBinData::ckDispose(bd)


    ProcedureReturn
EndProcedure