(PowerBuilder) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
integer li_Success
oleobject loo_Zip
oleobject loo_Entry
string ls_ZipPath
integer li_Recurse
integer li_SaveExtraPath
integer li_ArchiveOnly
integer li_IncludeHidden
integer li_IncludeSystem
integer li_Count
integer i
oleobject loo_ETemp

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

loo_Zip = create oleobject
// Use "Chilkat_9_5_0.Zip" for versions of Chilkat < 10.0.0
li_rc = loo_Zip.ConnectToNewObject("Chilkat.Zip")
if li_rc < 0 then
    destroy loo_Zip
    MessageBox("Error","Connecting to COM object failed")
    return
end if

ls_ZipPath = "c:/temp/qa_output/out.zip"

// Initialize the zip object with the path of the .zip to be created.
loo_Zip.NewZip(ls_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.
li_Recurse = 1
li_SaveExtraPath = 0
li_ArchiveOnly = 0
li_IncludeHidden = 1
li_IncludeSystem = 0
li_Success = loo_Zip.AppendFilesEx("c:/temp/files_to_zip",li_Recurse,li_SaveExtraPath,li_ArchiveOnly,li_IncludeHidden,li_IncludeSystem)
if li_Success = 0 then
    Write-Debug loo_Zip.LastErrorText
    destroy loo_Zip
    return
end if

// Note: We can iterate over the references to the files that will be processed when zipping:
li_Count = loo_Zip.NumEntries
i = 0
do while i < li_Count
    loo_Entry = loo_Zip.GetEntryByIndex(i)
    Write-Debug loo_Entry.FileName + " entryType = " + string(loo_Entry.EntryType)
    destroy loo_Entry
    i = i + 1
loop
Write-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:
loo_ETemp = loo_Zip.AppendString("helloWorld.txt","Hello World")
destroy loo_ETemp

// Now let's have a look at what will get zipped when we write the zip:
li_Count = loo_Zip.NumEntries
i = 0
do while i < li_Count
    loo_Entry = loo_Zip.GetEntryByIndex(i)
    Write-Debug loo_Entry.FileName + " entryType = " + string(loo_Entry.EntryType)
    destroy loo_Entry
    i = i + 1
loop
Write-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.
loo_Zip.FileName = ls_ZipPath
li_Success = loo_Zip.WriteZip()
if li_Success = 0 then
    Write-Debug loo_Zip.LastErrorText
    destroy loo_Zip
    return
end if

// Let's look again at the entries in the .zip
li_Count = loo_Zip.NumEntries
i = 0
do while i < li_Count
    loo_Entry = loo_Zip.GetEntryByIndex(i)
    Write-Debug loo_Entry.FileName + " entryType = " + string(loo_Entry.EntryType)
    destroy loo_Entry
    i = i + 1
loop
Write-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...

loo_ETemp = loo_Zip.AppendString("helloWorld2.txt","Hello World 2")
destroy loo_ETemp

// Write the .zip, including the new entries..
li_Success = loo_Zip.WriteZip()
if li_Success = 0 then
    Write-Debug loo_Zip.LastErrorText
    destroy loo_Zip
    return
end if

// Finally, let's look again at the entries in the .zip
li_Count = loo_Zip.NumEntries
i = 0
do while i < li_Count
    loo_Entry = loo_Zip.GetEntryByIndex(i)
    Write-Debug loo_Entry.FileName + " entryType = " + string(loo_Entry.EntryType)
    destroy loo_Entry
    i = i + 1
loop
Write-Debug "----"

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

loo_Zip.CloseZip()

Write-Debug "Success"


destroy loo_Zip