(PureBasic) Zip Append Files and Entry Type

See more Zip Examples

Demonstrates appending files to a zip object for writing a .zip. Also explains the "entry type".

Chilkat PureBasic Module Download Chilkat PureBasic Module

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

Procedure ChilkatExample()

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

    success.i

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

    entry.i

    zipPath.s = "c:/temp/qa_output/out.zip"

    ; Initialize the zip object with the path of the .zip to be created.
    CkZip::ckNewZip(zip,zipPath)

    ; Recursively append to the zip object the paths of the files and directories in a directory tree.
    ; At this point we are not creating the .zip, nor are we reading the contents of the files.
    ; We are simply appending references to the files and directories in the local filesystem
    ; that will get processed when WriteZip is called.
    recurse.i = 1
    saveExtraPath.i = 0
    archiveOnly.i = 0
    includeHidden.i = 1
    includeSystem.i = 0
    success = CkZip::ckAppendFilesEx(zip,"c:/temp/files_to_zip",recurse,saveExtraPath,archiveOnly,includeHidden,includeSystem)
    If success = 0
        Debug CkZip::ckLastErrorText(zip)
        CkZip::ckDispose(zip)
        ProcedureReturn
    EndIf

    ; Note: We can iterate over the references to the files that will be processed when zipping:
    count.i = CkZip::ckNumEntries(zip)
    i.i = 0
    While i < count
        entry = CkZip::ckGetEntryByIndex(zip,i)
        Debug CkZipEntry::ckFileName(entry) + " entryType = " + Str(CkZipEntry::ckEntryType(entry))
        CkZipEntry::ckDispose(entry)

        i = i + 1
    Wend
    Debug "----"

    ; Sample output for the above loop:
    ; The entry type = 1, because these are entries that are references to files in the local filesystem
    ; that are to be processed when the zip is written.

    ; hamlet.xml entryType = 1
    ; hello.pdf entryType = 1
    ; ...
    ; ...

    ; Possible entry type values:
    ; 0 - Mapped Entry: An entry in an existing Zip file.
    ; 1 - File Entry: A file not yet in memory, but referenced. These entries are added by calling AppendFiles, AppendFilesEx, AppendOneFileOrDir, etc.
    ; 2 - Data Entry: An entry containing uncompressed data from memory. These entries are added by calling AppendData, AppendString, etc.
    ; 3 - Null Entry: An entry that no longer exists in the .zip.
    ; 4 - New Directory Entry: A directory entry added by calling AppendNewDir. 

    ; The application can continue to add additional entries.
    ; For example:
    eTemp.i = CkZip::ckAppendString(zip,"helloWorld.txt","Hello World")
    CkZipEntry::ckDispose(eTemp)

    ; Now let's have a look at what will get zipped when we write the zip:
    count = CkZip::ckNumEntries(zip)
    i = 0
    While i < count
        entry = CkZip::ckGetEntryByIndex(zip,i)
        Debug CkZipEntry::ckFileName(entry) + " entryType = " + Str(CkZipEntry::ckEntryType(entry))
        CkZipEntry::ckDispose(entry)

        i = i + 1
    Wend
    Debug "----"

    ; You can see that "helloWorld.txt" is added. 
    ; Its entryType = 2, which means it is in-memory data (it is not a reference to a file in the local filesystem).

    ; hamlet.xml entryType = 1
    ; hello.pdf entryType = 1
    ; ...
    ; ...
    ; helloWorld.txt entryType = 2

    ; ----------------------------------------------------------------------------
    ; Now we'll write the zip to a .zip file.
    CkZip::setCkFileName(zip, zipPath)
    success = CkZip::ckWriteZip(zip)
    If success = 0
        Debug CkZip::ckLastErrorText(zip)
        CkZip::ckDispose(zip)
        ProcedureReturn
    EndIf

    ; Let's look again at the entries in the .zip
    count = CkZip::ckNumEntries(zip)
    i = 0
    While i < count
        entry = CkZip::ckGetEntryByIndex(zip,i)
        Debug CkZipEntry::ckFileName(entry) + " entryType = " + Str(CkZipEntry::ckEntryType(entry))
        CkZipEntry::ckDispose(entry)

        i = i + 1
    Wend
    Debug "----"

    ; After writing the .zip, the entry types change to 0.
    ; Entry type 0 indicates that it's a "mapped entry", which is an entry in an existing (and currently open) .zip file.

    ; hamlet.xml entryType = 0
    ; hello.pdf entryType = 0
    ; ...
    ; ...
    ; helloWorld.txt entryType = 0

    ; ----------------------------------------------------------------------------
    ; If desired, we could continue adding additional entries of any kind (files or data) to the currently open .zip archive...

    eTemp = CkZip::ckAppendString(zip,"helloWorld2.txt","Hello World 2")
    CkZipEntry::ckDispose(eTemp)

    ; Write the .zip, including the new entries..
    success = CkZip::ckWriteZip(zip)
    If success = 0
        Debug CkZip::ckLastErrorText(zip)
        CkZip::ckDispose(zip)
        ProcedureReturn
    EndIf

    ; Finally, let's look again at the entries in the .zip
    count = CkZip::ckNumEntries(zip)
    i = 0
    While i < count
        entry = CkZip::ckGetEntryByIndex(zip,i)
        Debug CkZipEntry::ckFileName(entry) + " entryType = " + Str(CkZipEntry::ckEntryType(entry))
        CkZipEntry::ckDispose(entry)

        i = i + 1
    Wend
    Debug "----"

    ; hamlet.xml entryType = 0
    ; hello.pdf entryType = 0
    ; ...
    ; ...
    ; helloWorld.txt entryType = 0
    ; helloWorld2.txt entryType = 0

    CkZip::ckCloseZip(zip)

    Debug "Success"


    CkZip::ckDispose(zip)


    ProcedureReturn
EndProcedure