PureBasic

Append Text Data to an Existing ZIP Entry Using ZipEntry.AppendString

See more Zip Examples

This example demonstrates how to use the ZipEntry.AppendString method to append text data to an existing ZIP entry.

The example opens an existing ZIP archive, locates a text file entry, and appends additional text to the end of the file contents.

An important concept demonstrated by this example is that appending data to a ZIP entry transforms the entry into an in-memory Data Entry (EntryType = 2).

For example:

• If the entry is a mapped entry from an opened ZIP archive (EntryType = 0), the compressed entry is first inflated into memory.
• If the entry is a referenced filesystem file (EntryType = 1), the file contents are first loaded into memory.

The new text is then appended to the uncompressed in-memory data, and the entry becomes a Data Entry.

After the ZIP archive is rewritten, the modified entry again becomes a mapped entry stored within the ZIP archive.

PureBasic

IncludeFile "CkZip.pb"
IncludeFile "CkZipEntry.pb"

Procedure ChilkatExample()

    success.i = 0

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

    ; ------------------------------------------------------------
    ; Open an existing ZIP archive.
    success = CkZip::ckOpenZip(zip,"c:/temp/notes.zip")
    If success = 0
        Debug CkZip::ckLastErrorText(zip)
        CkZip::ckDispose(zip)
        ProcedureReturn
    EndIf

    ; Locate a text file entry within the ZIP archive.
    entry.i = CkZipEntry::ckCreate()
    If entry.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkZip::ckEntryOf(zip,"notes/readme.txt",entry)

    If success <> 0

        ; --------------------------------------------------------
        ; At this point, the entry is a mapped entry because it
        ; originates from an opened ZIP archive.
        ; 
        ;     EntryType = 0
        ; 
        Debug "Initial EntryType = " + Str(CkZipEntry::ckEntryType(entry))

        ; Append additional text to the ZIP entry.
        ; 
        ; The existing compressed ZIP entry is first inflated
        ; into memory. The new text is then appended.
        ; 
        ; After AppendString is called, the entry becomes
        ; an in-memory Data Entry:
        ; 
        ;     EntryType = 2
        ; 
        success = CkZipEntry::ckAppendString(entry,Chr(13) + Chr(10) + "Additional notes added later.","utf-8")

        If success = 0
            Debug CkZip::ckLastErrorText(zip)
            CkZip::ckDispose(zip)
            CkZipEntry::ckDispose(entry)
            ProcedureReturn
        EndIf

        Debug "EntryType after AppendString = " + Str(CkZipEntry::ckEntryType(entry))

        ; --------------------------------------------------------
        ; Write the modified ZIP archive to a different file.
        ; 
        ; Changing zip.FileName causes the ZIP archive to be
        ; written to a new output file rather than overwriting
        ; the original ZIP archive.
        ; 
        CkZip::setCkFileName(zip, "qa_output/updatedExample.zip")

        ; Rewrite the ZIP archive.
        ; 
        ; The modified in-memory entry is compressed and written
        ; into the new ZIP archive.
        ; 
        success = CkZip::ckWriteZip(zip)
        If success = 0
            Debug CkZip::ckLastErrorText(zip)
            CkZip::ckDispose(zip)
            CkZipEntry::ckDispose(entry)
            ProcedureReturn
        EndIf

        ; After rewriting the ZIP archive, the entry again becomes
        ; a mapped entry:
        ; 
        ;     EntryType = 0
        ; 
        Debug "EntryType after WriteZip = " + Str(CkZipEntry::ckEntryType(entry))
    EndIf

    CkZip::ckCloseZip(zip)

    Debug "ZIP entry updated successfully."


    CkZip::ckDispose(zip)
    CkZipEntry::ckDispose(entry)


    ProcedureReturn
EndProcedure