PureBasic

Add Custom Extra Data to a Gzip File

This example demonstrates how to use the SetExtraData method to include custom binary data in the Gzip header using a hex-encoded string.

The hex string represents the raw bytes to embed in the Gzip metadata. When a compression method is called, this data is included in the Gzip header.

The example also shows how to retrieve the metadata using GetGzipInfo to verify that the extra data was successfully embedded. The retrieved value is returned as a Base64-encoded string.

PureBasic

IncludeFile "CkGzip.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

    ; This example demonstrates how to include custom extra data
    ; in the Gzip header when compressing.

    ; The extra data is provided as a hex-encoded string.

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

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

    ; Set extra data using a hex string.
    ; This example represents 4 bytes: 00 01 02 03
    success = CkGzip::ckSetExtraData(gzip,"00010203","hex")
    If success = 0
        Debug CkGzip::ckLastErrorText(gzip)
        CkGzip::ckDispose(gzip)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    ; Compress a file so the extra data is embedded in the Gzip header:
    inputFile.s = "example.txt"
    outputFile.s = "example.txt.gz"

    success = CkGzip::ckCompressFile(gzip,inputFile,outputFile)
    If success = 0
        Debug CkGzip::ckLastErrorText(gzip)
        CkGzip::ckDispose(gzip)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug "Gzip file created with extra data."

    ; (Optional) Retrieve the metadata to verify:
    success = CkGzip::ckGetGzipInfo(gzip,outputFile,json)
    If success = 0
        Debug CkGzip::ckLastErrorText(gzip)
        CkGzip::ckDispose(gzip)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug "Metadata JSON:"
    Debug CkJsonObject::ckEmit(json)


    CkGzip::ckDispose(gzip)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure