(C) 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 C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <C_CkZip.h>
#include <C_CkZipEntry.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkZip zip;
    HCkZipEntry entry;
    const char *zipPath;
    BOOL recurse;
    BOOL saveExtraPath;
    BOOL archiveOnly;
    BOOL includeHidden;
    BOOL includeSystem;
    int count;
    int i;
    HCkZipEntry eTemp;

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

    zip = CkZip_Create();

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

    // Initialize the zip object with the path of the .zip to be created.
    CkZip_NewZip(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 = TRUE;
    saveExtraPath = FALSE;
    archiveOnly = FALSE;
    includeHidden = TRUE;
    includeSystem = FALSE;
    success = CkZip_AppendFilesEx(zip,"c:/temp/files_to_zip",recurse,saveExtraPath,archiveOnly,includeHidden,includeSystem);
    if (success == FALSE) {
        printf("%s\n",CkZip_lastErrorText(zip));
        CkZip_Dispose(zip);
        return;
    }

    // Note: We can iterate over the references to the files that will be processed when zipping:
    count = CkZip_getNumEntries(zip);
    i = 0;
    while (i < count) {
        entry = CkZip_GetEntryByIndex(zip,i);
        printf("%s entryType = %d\n",CkZipEntry_fileName(entry),CkZipEntry_getEntryType(entry));
        CkZipEntry_Dispose(entry);
        i = i + 1;
    }

    printf("----\n");

    // 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 = CkZip_AppendString(zip,"helloWorld.txt","Hello World");
    CkZipEntry_Dispose(eTemp);

    // Now let's have a look at what will get zipped when we write the zip:
    count = CkZip_getNumEntries(zip);
    i = 0;
    while (i < count) {
        entry = CkZip_GetEntryByIndex(zip,i);
        printf("%s entryType = %d\n",CkZipEntry_fileName(entry),CkZipEntry_getEntryType(entry));
        CkZipEntry_Dispose(entry);
        i = i + 1;
    }

    printf("----\n");

    // 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_putFileName(zip,zipPath);
    success = CkZip_WriteZip(zip);
    if (success == FALSE) {
        printf("%s\n",CkZip_lastErrorText(zip));
        CkZip_Dispose(zip);
        return;
    }

    // Let's look again at the entries in the .zip
    count = CkZip_getNumEntries(zip);
    i = 0;
    while (i < count) {
        entry = CkZip_GetEntryByIndex(zip,i);
        printf("%s entryType = %d\n",CkZipEntry_fileName(entry),CkZipEntry_getEntryType(entry));
        CkZipEntry_Dispose(entry);
        i = i + 1;
    }

    printf("----\n");

    // 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_AppendString(zip,"helloWorld2.txt","Hello World 2");
    CkZipEntry_Dispose(eTemp);

    // Write the .zip, including the new entries..
    success = CkZip_WriteZip(zip);
    if (success == FALSE) {
        printf("%s\n",CkZip_lastErrorText(zip));
        CkZip_Dispose(zip);
        return;
    }

    // Finally, let's look again at the entries in the .zip
    count = CkZip_getNumEntries(zip);
    i = 0;
    while (i < count) {
        entry = CkZip_GetEntryByIndex(zip,i);
        printf("%s entryType = %d\n",CkZipEntry_fileName(entry),CkZipEntry_getEntryType(entry));
        CkZipEntry_Dispose(entry);
        i = i + 1;
    }

    printf("----\n");

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

    CkZip_CloseZip(zip);

    printf("Success\n");


    CkZip_Dispose(zip);

    }