(PureBasic) Add Data to multipart/form-data Request

Demonstrates how to add content (such as a JPG, PDF, XML, etc.) to multipart/form-data requests.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpRequest.pb"
IncludeFile "CkBinData.pb"

Procedure ChilkatExample()

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

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

    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkContentType(req, "multipart/form-data")
    CkHttpRequest::setCkPath(req, "/xyz/something")

    CkHttpRequest::ckAddParam(req,"param1","value1")
    CkHttpRequest::ckAddParam(req,"param2","value2")

    ; Add some small files to the request. (Small so we can see what the full request looks like without too much data..)
    bd.i = CkBinData::ckCreate()
    If bd.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkBinData::ckLoadFile(bd,"qa_data/jpg/starfish20.jpg")
    CkHttpRequest::ckAddBdForUpload(req,"starfish20","starfish20.jpg",bd,"image/jpeg")

    success = CkBinData::ckLoadFile(bd,"qa_data/pdf/helloWorld.pdf")
    CkHttpRequest::ckAddBdForUpload(req,"helloWorld","helloWorld.pdf",bd,"application/pdf")

    success = CkBinData::ckLoadFile(bd,"qa_data/xml/tinyA.xml")
    CkHttpRequest::ckAddBdForUpload(req,"tinyA","tinyA.xml",bd,"text/xml")

    ; This HTTP request contains binary data, so we cannot call GenerateRequestText
    ; to examine it as a string.  We can instead call GenerateRequestFile
    ; to write the request to a file and then examine using a hex editor,
    ; or an editor that is capable of handling null bytes and non-printable chars (perhaps by displaying "?" chars instead).
    CkHttpRequest::ckGenerateRequestFile(req,"qa_output/multipartFormDataRequest.bin")

    Debug "OK."

    ; This is the HTTP multipart/form-data request built by the above code:

    ; POST /xyz/something HTTP/1.1
    ; Host: domain
    ; Content-Type: multipart/form-data; boundary=------------090708030009010000030901
    ; Content-Length: 2220
    ; 
    ; --------------090708030009010000030901
    ; Content-Disposition: form-data; name="param1"
    ; 
    ; value1
    ; --------------090708030009010000030901
    ; Content-Disposition: form-data; name="param2"
    ; 
    ; value2
    ; --------------090708030009010000030901
    ; Content-Disposition: form-data; name="starfish20"; filename="starfish20.jpg"
    ; Content-Type: image/jpeg
    ; 
    ; JPEG DATA HERE...
    ; --------------090708030009010000030901
    ; Content-Disposition: form-data; name="helloWorld"; filename="helloWorld.pdf"
    ; Content-Type: application/pdf
    ; 
    ; PDF DATA HERE...
    ; --------------090708030009010000030901
    ; Content-Disposition: form-data; name="tinyA"; filename="tinyA.xml"
    ; Content-Type: text/xml
    ; 
    ; XML DATA HERE...
    ; --------------090708030009010000030901--
    ; 


    CkHttpRequest::ckDispose(req)
    CkBinData::ckDispose(bd)


    ProcedureReturn
EndProcedure