PureBasic

Add a Common Root Directory to ZIP Entries Using PathPrefix

See more Zip Examples

This example demonstrates how to use the PathPrefix property to prepend a common directory path to all entries added to a ZIP archive.

The PathPrefix value is prepended to the stored ZIP paths for subsequently added entries.

This is useful when:

• Creating ZIP archives that extract beneath a single root directory
• Packaging applications or projects into a named top-level folder
• Avoiding extraction directly into the current directory
• Organizing ZIP contents beneath a common parent directory

Suppose the local filesystem contains:

c:/MyProject/src/main.cpp
c:/MyProject/src/util.cpp
c:/MyProject/docs/readme.txt

And suppose the following code is executed:

zip.PathPrefix = "MyProject/";

Then the ZIP archive will contain:

MyProject/src/main.cpp
MyProject/src/util.cpp
MyProject/docs/readme.txt

Without a PathPrefix, the ZIP archive would instead contain:

src/main.cpp
src/util.cpp
docs/readme.txt

The PathPrefix is applied only to entries added after the property is set.

PureBasic

IncludeFile "CkZip.pb"

Procedure ChilkatExample()

    success.i = 0

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

    ; Create a new ZIP archive.
    success = CkZip::ckNewZip(zip,"MyProject.zip")
    If success = 0
        Debug CkZip::ckLastErrorText(zip)
        CkZip::ckDispose(zip)
        ProcedureReturn
    EndIf

    ; Prepend "MyProject/" to all subsequently added ZIP entries.
    ; 
    ; This causes all files to extract beneath a top-level
    ; directory named "MyProject".
    CkZip::setCkPathPrefix(zip, "MyProject/")

    ; Recursively add project files.
    ; 
    ; Because saveExtraPath = 0, the stored ZIP paths
    ; will normally begin with:
    ; 
    ;     src/
    ;     docs/
    ; 
    ; But because PathPrefix = "MyProject/",
    ; the final ZIP paths become:
    ; 
    ;     MyProject/src/
    ;     MyProject/docs/
    ; 
    recurse.i = 1
    success = CkZip::ckAppendFiles(zip,"c:/MyProject/*",recurse)

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

    ; Write the ZIP archive and close it.
    success = CkZip::ckWriteZipAndClose(zip)
    If success = 0
        Debug CkZip::ckLastErrorText(zip)
        CkZip::ckDispose(zip)
        ProcedureReturn
    EndIf

    Debug "ZIP archive created successfully."


    CkZip::ckDispose(zip)


    ProcedureReturn
EndProcedure