ZipEntry C++ Reference Documentation

CkZipEntry

Current Version: 11.0.0
Requires Chilkat Bundle License

Represents a single file or directory entry within a Chilkat Zip object. A zip entry can be one of 5 types (see the description of the EntryType property below).

Object Creation

// Local variable on the stack
CkZipEntry obj;

// Dynamically allocate/delete
CkZipEntry *pObj = new CkZipEntry();
// ...
delete pObj;

Properties

Comment
void get_Comment(CkString &str);
const char *comment(void);
void put_Comment(const char *ansiOrUtf8Str);

The comment stored within the Zip for this entry.

top
CompressedLength
unsigned long get_CompressedLength(void);

The size in bytes of this entry's file data when compression is applied

top
CompressedLength64
__int64 get_CompressedLength64(void);

The size in bytes of this entry's file data when compression is applied

top
CompressedLengthStr
void get_CompressedLengthStr(CkString &str);
const char *compressedLengthStr(void);

The size in decimal string format of this file when Zip compression is applied.

top
CompressionLevel
int get_CompressionLevel(void);
void put_CompressionLevel(int newVal);

The compression level. 0 = no compression, while 9 = maximum compression. The default is 6.

top
CompressionMethod
int get_CompressionMethod(void);
void put_CompressionMethod(int newVal);

Set to 0 for no compression, or 8 for the Deflate algorithm. The Deflate algorithm is the default algorithm of the most popular Zip utility programs, such as WinZip

top
Crc
int get_Crc(void);

The CRC for the zip entry. For AES encrypted entries, the CRC value will be 0. (See http://www.winzip.com/aes_info.htm#CRC )

top
DebugLogFilePath
void get_DebugLogFilePath(CkString &str);
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *ansiOrUtf8Str);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
EncryptionKeyLen
int get_EncryptionKeyLen(void);
Introduced in version 9.5.0.69

If this entry is AES encrypted, then this property contains the AES key length (128, 192, or 256). If the entry is not AES encrypted, then the value is 0.

top
EntryID
int get_EntryID(void);

A unique ID assigned to the entry while the object is instantiated in memory.

top
EntryType
int get_EntryType(void);

Indicates the origin of the entry. There are three possible values:

    0>
  1. Mapped Entry: An entry in an existing Zip file.
  2. File Entry: A file not yet in memory, but referenced. These entries are added by calling AppendFiles, AppendFilesEx, AppendOneFileOrDir, etc.
  3. Data Entry: An entry containing uncompressed data from memory. These entries are added by calling AppendData, AppendString, etc.
  4. Null Entry: An entry that no longer exists in the .zip.
  5. New Directory Entry: A directory entry added by calling AppendNewDir.
When the zip is written by calling WriteZip or WriteToMemory, all of the zip entries are transformed into mapped entries. They become entries that contain the compressed data within the .zip that was just created. (The WriteZip method call effectively writes the zip and then opens it, replacing all of the existing entries with mapped entries.)

More Information and Examples
Zip Append Files and Entry Type
top
FileDateTimeStr
void get_FileDateTimeStr(CkString &str);
const char *fileDateTimeStr(void);
void put_FileDateTimeStr(const char *ansiOrUtf8Str);

The local last-modified date/time in RFC822 string format.

top
FileName
void get_FileName(CkString &str);
const char *fileName(void);
void put_FileName(const char *ansiOrUtf8Str);

The file name of the Zip entry.

More Information and Examples
Set Entry Filepath (in output Zip) when Zipping
top
FileNameHex
void get_FileNameHex(CkString &str);
const char *fileNameHex(void);

A string containing the hex encoded raw filename bytes found in the Zip entry.

top
HeartbeatMs
int get_HeartbeatMs(void);
void put_HeartbeatMs(int newVal);

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete. By default, HeartbeatMs is set to 0, meaning no AbortCheck event callbacks will trigger.

More Information and Examples
Event Callback Examples
top
IsAesEncrypted
bool get_IsAesEncrypted(void);
Introduced in version 9.5.0.69

true if the entry is AES encrypted. This property can only be true for entries already contained in a .zip (i.e. entries obtained from a zip archive that was opened via OpenZip, OpenBd, OpenFromMemory, etc.) The property is false if the entry contained in the zip is not AES encrypted.

top
IsDirectory
bool get_IsDirectory(void);

True if the Zip entry is a directory, false if it is a file.

top
LastErrorHtml
void get_LastErrorHtml(CkString &str);
const char *lastErrorHtml(void);

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
void get_LastErrorText(CkString &str);
const char *lastErrorText(void);

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
void get_LastErrorXml(CkString &str);
const char *lastErrorXml(void);

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
TextFlag
bool get_TextFlag(void);
void put_TextFlag(bool newVal);

Controls whether the text flag of the internal file attributes for this entry within the zip is set. This is a bit flag that indicates whether the file contents are text or binary. It is for informational use and it is not imperative that this bit flag is accurately set. The ability to set this bit flag is only provided to satisfy certain cases where another application might be sensitive to the flag.

top
UncompressedLength
unsigned long get_UncompressedLength(void);

The size in bytes of this entry's file data when uncompressed.

top
UncompressedLength64
__int64 get_UncompressedLength64(void);

The size in bytes of this entry's file data when uncompressed.

top
UncompressedLengthStr
void get_UncompressedLengthStr(CkString &str);
const char *uncompressedLengthStr(void);

The size in bytes (in decimal string format) of this zip entry's data when uncompressed.

top
Utf8
bool get_Utf8(void);
void put_Utf8(bool newVal);

When set to true, all const char * arguments and return values are interpreted as UTF-8 strings. When set to false, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is true. Before v11.0.0, it was false.

top
VerboseLogging
bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
void get_Version(CkString &str);
const char *version(void);

Version of the component/library, such as "10.1.0"

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

AppendString
bool AppendString(const char *strContent, const char *charset);

Appends text data to the zip entry's file contents. The text is appended using the character encoding specified by the charset, which can be utf-8, ansi, etc.

Returns true for success, false for failure.

top
AppendStringAsync (1)
CkTask *AppendStringAsync(const char *strContent, const char *charset);

Creates an asynchronous task to call the AppendString method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
CopyToBase64
bool CopyToBase64(CkString &outStr);
const char *copyToBase64(void);

Returns the compressed data as a Base64-encoded string. It is only possible to retrieve the compressed data from a pre-existing .zip that has been opened or after writing the .zip but not closing it.

Note: The CopyToBase64 method can only be called if the zip entry already contains compressed data (i.e. it is a mapped entry).

Returns true for success, false for failure.

top
CopyToHex
bool CopyToHex(CkString &outStr);
const char *copyToHex(void);

Returns the compressed data as a hexidecimal encoded string. It is only possible to retrieve the compressed data from a pre-existing .zip that has been opened or after writing the .zip but not closing it.

Note: The CopyToBase64 method can only be called if the zip entry already contains compressed data (i.e. it is a mapped entry).

Returns true for success, false for failure.

top
Extract
bool Extract(const char *dirPath);

Unzips this entry into the specified base directory. The file is unzipped to the subdirectory according to the relative path stored with the entry in the Zip. Use ExtractInto to unzip into a specific directory regardless of the path information stored in the Zip.

Returns true for success, false for failure.

top
ExtractAsync (1)
CkTask *ExtractAsync(const char *dirPath);

Creates an asynchronous task to call the Extract method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
ExtractInto
bool ExtractInto(const char *dirPath);

Unzip a file into a specific directory. If this entry is a directory, then nothing occurs. (An application can check the IsDirectory property and instead call Extract if it is desired to create the directory. )

Returns true for success, false for failure.

top
ExtractIntoAsync (1)
CkTask *ExtractIntoAsync(const char *dirPath);

Creates an asynchronous task to call the ExtractInto method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
GetNext
bool GetNext(void);
Introduced in version 11.0.0

Updates this object to the next entry (file or directory) within this zip.

Returns true for success, false for failure.

top
GetNextMatch
bool GetNextMatch(const char *pattern);
Introduced in version 11.0.0

Updates this object to the next matching entry (file or directory) within this zip. The * characters matches 0 or more of any character. The full filename, including path, is used when matching against the pattern.

Returns true for success, false for failure.

top
LoadTaskCaller
bool LoadTaskCaller(CkTask &task);
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

top
ReplaceString
bool ReplaceString(const char *strContent, const char *charset);

Replaces the zip entry's existing contents with new text data. The text will be stored using the character encoding as specified by charset, which can be utf-8, ansi, etc.

Returns true for success, false for failure.

More Information and Examples
Replace/Update a FIle in a .zip
top
SetDt
void SetDt(CkDateTime &dt);

Sets the last-modified date/time for this zip entry.

top
UnzipToBd
bool UnzipToBd(CkBinData &binData);
Introduced in version 9.5.0.67

Unzips the entry contents into the binData.

Returns true for success, false for failure.

top
UnzipToBdAsync (1)
CkTask *UnzipToBdAsync(CkBinData &binData);
Introduced in version 9.5.0.67

Creates an asynchronous task to call the UnzipToBd method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
UnzipToSb
bool UnzipToSb(int lineEndingBehavior, const char *srcCharset, CkStringBuilder &sb);
Introduced in version 9.5.0.67

Unzips a text file to the sb. The contents of sb are appended with the unzipped file. The lineEndingBehavior is as follows:

0 = leave unchanged.
1 = convert all to bare LF's
2 = convert all to CRLF's

The srcCharset tells the component how to interpret the bytes of the uncompressed file -- i.e. as utf-8, utf-16, windows-1252, etc.

Returns true for success, false for failure.

top
UnzipToSbAsync (1)
CkTask *UnzipToSbAsync(int lineEndingBehavior, const char *srcCharset, CkStringBuilder &sb);
Introduced in version 9.5.0.67

Creates an asynchronous task to call the UnzipToSb method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
UnzipToStream
bool UnzipToStream(CkStream &toStream);
Introduced in version 9.5.0.67

Unzips a file within a Zip to a stream. If called synchronously, the toStream must have a sink, such as a file or another stream object. If called asynchronously, then the foreground thread can read the stream.

Returns true for success, false for failure.

More Information and Examples
Unzip Binary File to Stream
top
UnzipToStreamAsync (1)
CkTask *UnzipToStreamAsync(CkStream &toStream);
Introduced in version 9.5.0.67

Creates an asynchronous task to call the UnzipToStream method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples
Unzip One File to a Stream
top
UnzipToString
bool UnzipToString(int lineEndingBehavior, const char *srcCharset, CkString &outStr);
const char *unzipToString(int lineEndingBehavior, const char *srcCharset);

Inflate and return the uncompressed data as a string The lineEndingBehavior is as follows:

0 = leave unchanged.
1 = convert all to bare LF's
2 = convert all to CRLF's

The srcCharset tells the component how to interpret the bytes of the uncompressed file -- i.e. as utf-8, utf-16, windows-1252, etc.

Returns true for success, false for failure.

More Information and Examples
Iterate over Matching FilenamesDownload a Zip from a URL and OpenFromMemory. (No .zip fie is created)
top
UnzipToStringAsync (1)
CkTask *UnzipToStringAsync(int lineEndingBehavior, const char *srcCharset);

Creates an asynchronous task to call the UnzipToString method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top

Events

To implement an event callback, your application would define and implement a class that inherits from CkBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkBaseProgress base class.

For example:

  CkZipEntry zipentry;

  MyZipEntryProgress callbackObj;

  zipentry.put_EventCallbackObject(&callbackObj);

MyZipEntryProgress example:

#include "CkBaseProgress.h"

class MyZipEntryProgress : public CkBaseProgress {

  public:
    MyZipEntryProgress();
    virtual ~MyZipEntryProgress();

    void AbortCheck(bool  *abort);

    void PercentDone(int pctDone, bool  *abort);

    void ProgressInfo(const char *name, const char *value);

    void TaskCompleted(CkTask &task);

};
AbortCheck
void AbortCheck(bool *abort);

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

More Information and Examples
Chilkat Event Callback Examples
top
PercentDone
void PercentDone(int pctDone, bool *abort);

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the abort output argument to true. This will cause the method to terminate and return a failure status or corresponding failure value.

More Information and Examples
Chilkat Event Callback Examples
top
ProgressInfo
void ProgressInfo(const char *name, const char *value);

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

More Information and Examples
Chilkat Event Callback Examples
top
TaskCompleted
void TaskCompleted(CkTask &task);

Called from the background thread when an asynchronous task completes.

top

Deprecated

AppendData Deprecated
bool AppendData(CkByteData &inData);

Appends binary data to the zip entry's file contents.

Returns true for success, false for failure.

top
AppendDataAsync Deprecated (1)
CkTask *AppendDataAsync(CkByteData &inData);

Creates an asynchronous task to call the AppendData method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
Copy Deprecated
bool Copy(CkByteData &outData);

Returns the compressed data as a byte array.

Note: The Copy method can only be called if the zip entry already contains compressed data (i.e. it is a mapped entry). This is the case when an existing .zip is opened (from memory or from a file), or after the .zip has been written (by calling WriteZip or WriteToMemory). If a zip entry is created via AppendData, AppendFiles, etc., then it does not yet contain compressed data. When the zip is written, each entry becomes a mapped entry (The value of the EntryType property becomes 0.)

Returns true for success, false for failure.

top
GetDt
CkDateTime *GetDt(void);
This method is deprecated.

This method is deprecated and will be removed in a future version. Use the FileDateTimeStr property instead. Returns the last-modified date/time of this zip entry.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples
Transition from ZipEntry.GetDt to ZipEntry.FileDateTimeStr
top
Inflate Deprecated
bool Inflate(CkByteData &outData);

Inflate a file within a Zip directly into memory.

Returns true for success, false for failure.

top
InflateAsync Deprecated (1)
CkTask *InflateAsync(void);

Creates an asynchronous task to call the Inflate method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
NextEntry
CkZipEntry *NextEntry(void);
This method is deprecated and replaced by GetNext

This method is deprecated. Applications should instead call GetNext.

Return the next entry (file or directory) within the Zip

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples
Transition from ZipEntry.NextEntry to ZipEntry.GetNextList Files in Zip using FirstEntry/NextEntry
top
NextMatchingEntry
CkZipEntry *NextMatchingEntry(const char *matchStr);
Introduced in version 9.5.0.50
This method is deprecated and replaced by GetNextMatch

This method is deprecated. Applications should instead call GetNextMatch.

Returns the next entry having a filename matching a pattern. The * characters matches 0 or more of any character. The full filename, including path, is used when matching against the pattern. A NULL is returned if nothing matches.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples
Iterate over Matching Filenames
top
ReplaceData Deprecated
bool ReplaceData(CkByteData &inData);

Replaces the zip entry's existing contents with new data.

Returns true for success, false for failure.

top