(PureBasic) Add File Attachments to a PDF

See more PDF Signatures Examples

Demonstrates how to attach files to a PDF. This is also known as embedding a file within a PDF.

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkBinData.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkPdf.pb"

Procedure ChilkatExample()

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

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

    ; We'll be adding attachments to this PDF file..
    ; Note: We are loading the PDF file into memory.  The PDF file is not kept open at this point.
    success.i = CkPdf::ckLoadFile(pdf,"qa_data/pdf/helloWorld.pdf")
    If success = 0
        Debug CkPdf::ckLastErrorText(pdf)
        CkPdf::ckDispose(pdf)
        ProcedureReturn
    EndIf

    ; Note: The ability to attach files to a PDF was added in Chilkat v9.5.0.97

    ; Build JSON to provide information about the files to be embedded in the PDF.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(json, 0)

    i.i = 0

    ; We can attach multiple files in one operation.

    ; Here we specify the local relative file path of the 1st file to be embedded.
    CkJsonObject::setCkI(json, i)
    CkJsonObject::ckUpdateString(json,"files[i].description","Hello World")
    CkJsonObject::ckUpdateString(json,"files[i].localFilePath","qa_data/xml/helloWorld.xml")
    i = i + 1

    ; Specify the 2nd file to be attached.
    CkJsonObject::setCkI(json, i)
    CkJsonObject::ckUpdateString(json,"files[i].description","Image of starfish")
    CkJsonObject::ckUpdateString(json,"files[i].localFilePath","qa_data/jpg/starfish.jpg")
    ; You can explicitly specify the subType (i.e. MIME type) of the file.
    ; Otherwise Chilkat will use the default MIME type based on the filename extension.
    ; If no default MIME type exists, then "application/octet-stream" is used.
    CkJsonObject::ckUpdateString(json,"files[i].subType","image/jpeg")
    i = i + 1

    ; You can alternatively provide the file data from base64 encoded data rather than from a local file.
    CkJsonObject::setCkI(json, i)
    CkJsonObject::ckUpdateString(json,"files[i].description","Hello World from Data")
    CkJsonObject::ckUpdateString(json,"files[i].fileData","SGVsbG8gV29ybGQsIEhlbGxvIFdvcmxkLCBIZWxsbyBXb3JsZCwgSGVsbG8gV29ybGQsIEhlbGxvIFdvcmxk")
    CkJsonObject::ckUpdateString(json,"files[i].embeddedFilename","abc.txt")
    i = i + 1

    ; By default, the filename used within the PDF is the filename part of the local file path.
    ; You can change it by specifying the embeddedFilename.
    CkJsonObject::setCkI(json, i)
    CkJsonObject::ckUpdateString(json,"files[i].description","Invoice")
    CkJsonObject::ckUpdateString(json,"files[i].localFilePath","qa_data/xml/invoice.xml")
    CkJsonObject::ckUpdateString(json,"files[i].embeddedFilename","invoice_1234.xml")
    CkJsonObject::ckUpdateString(json,"files[i].subType","application/xml")

    ; The above JSON provides instructions for attaching 4 files to the PDF.
    ; Let's attach the files..
    ; It is perfectly acceptable to write over the PDF file that was loaded,
    ; but in this example we'll write the PDF with attachments to a new PDF file.
    success = CkPdf::ckAddEmbeddedFiles(pdf,json,"qa_output/helloWorld_withAttachments.pdf")
    If success = 0
        Debug CkPdf::ckLastErrorText(pdf)
        CkPdf::ckDispose(pdf)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    ; You can alternatively write the PDF file with attachments to a Chilkat BinData object..
    bd.i = CkBinData::ckCreate()
    If bd.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkPdf::ckAddEmbeddedFilesBd(pdf,json,bd)
    If success = 0
        Debug CkPdf::ckLastErrorText(pdf)
        CkPdf::ckDispose(pdf)
        CkJsonObject::ckDispose(json)
        CkBinData::ckDispose(bd)
        ProcedureReturn
    EndIf

    ; Then you can do what you want with the BinData, which contains the binary image of the PDF with attachments.

    Debug "Success."


    CkPdf::ckDispose(pdf)
    CkJsonObject::ckDispose(json)
    CkBinData::ckDispose(bd)


    ProcedureReturn
EndProcedure