ZipEntry C Reference Documentation

ZipEntry

Current Version: 9.5.0.97

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).

Create/Dispose

HCkZipEntry instance = CkZipEntry_Create();
// ...
CkZipEntry_Dispose(instance);
HCkZipEntry CkZipEntry_Create(void);

Creates an instance of the HCkZipEntry object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkZipEntry_Dispose(HCkZipEntry handle);

Objects created by calling CkZipEntry_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkZipEntry_Dispose.

Callback Functions

Callback Functions introduced in Chilkat v9.5.0.56
void CkZipEntry_setAbortCheck(HCkZipEntry cHandle, BOOL (*fnAbortCheck)(void));

Provides the opportunity for a method call to be aborted. If TRUE is returned, the operation in progress is aborted. Return FALSE to allow the current method call to continue. This callback function is called periodically based on the value of the HeartbeatMs property. (If HeartbeatMs is 0, then no callbacks are made.) As an example, to make 5 AbortCheck callbacks per second, set the HeartbeatMs property equal to 200.

void CkZipEntry_setPercentDone(HCkZipEntry cHandle, BOOL (*fnPercentDone)(int pctDone));

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This callback is only called when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For methods that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

This callback counts as an AbortCheck callback, and takes the place of the AbortCheck event when it fires.

The return value indicates whether the method call should be aborted, or whether it should proceed. Return TRUE to abort, and FALSE to proceed.

void CkZipEntry_setProgressInfo(HCkZipEntry cHandle, void (*fnProgressInfo)(const char *name, const char *value));

This is a general callback that provides name/value information about what is happening at certain points during a method call. To see the information provided in ProgressInfo callbacks, if any, write code to handle this event and log the name/value pairs. Most are self-explanatory.

void CkZipEntry_setTaskCompleted(HCkZipEntry cHandle, void (*fnTaskCompleted)(HCkTask hTask));

Called in the background thread when an asynchronous task completes. (Note: When an async method is running, all callbacks are in the background thread.)

Properties

Comment
void CkZipEntry_getComment(HCkZipEntry cHandle, HCkString retval);
void CkZipEntry_putComment(HCkZipEntry cHandle, const char *newVal);
const char *CkZipEntry_comment(HCkZipEntry cHandle);

The comment stored within the Zip for this entry.

top
CompressedLength
unsigned long CkZipEntry_getCompressedLength(HCkZipEntry cHandle);

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

top
CompressedLength64
__int64 CkZipEntry_getCompressedLength64(HCkZipEntry cHandle);

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

top
CompressedLengthStr
void CkZipEntry_getCompressedLengthStr(HCkZipEntry cHandle, HCkString retval);
const char *CkZipEntry_compressedLengthStr(HCkZipEntry cHandle);

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

top
CompressionLevel
int CkZipEntry_getCompressionLevel(HCkZipEntry cHandle);
void CkZipEntry_putCompressionLevel(HCkZipEntry cHandle, int newVal);

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

top
CompressionMethod
int CkZipEntry_getCompressionMethod(HCkZipEntry cHandle);
void CkZipEntry_putCompressionMethod(HCkZipEntry cHandle, 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 CkZipEntry_getCrc(HCkZipEntry cHandle);

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 CkZipEntry_getDebugLogFilePath(HCkZipEntry cHandle, HCkString retval);
void CkZipEntry_putDebugLogFilePath(HCkZipEntry cHandle, const char *newVal);
const char *CkZipEntry_debugLogFilePath(HCkZipEntry cHandle);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
EncryptionKeyLen
int CkZipEntry_getEncryptionKeyLen(HCkZipEntry cHandle);
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 CkZipEntry_getEntryID(HCkZipEntry cHandle);

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

top
EntryType
int CkZipEntry_getEntryType(HCkZipEntry cHandle);

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

  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.)

top
FileDateTimeStr
void CkZipEntry_getFileDateTimeStr(HCkZipEntry cHandle, HCkString retval);
void CkZipEntry_putFileDateTimeStr(HCkZipEntry cHandle, const char *newVal);
const char *CkZipEntry_fileDateTimeStr(HCkZipEntry cHandle);

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

top
FileName
void CkZipEntry_getFileName(HCkZipEntry cHandle, HCkString retval);
void CkZipEntry_putFileName(HCkZipEntry cHandle, const char *newVal);
const char *CkZipEntry_fileName(HCkZipEntry cHandle);

The file name of the Zip entry.

top
FileNameHex
void CkZipEntry_getFileNameHex(HCkZipEntry cHandle, HCkString retval);
const char *CkZipEntry_fileNameHex(HCkZipEntry cHandle);

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

top
HeartbeatMs
int CkZipEntry_getHeartbeatMs(HCkZipEntry cHandle);
void CkZipEntry_putHeartbeatMs(HCkZipEntry cHandle, int newVal);

The number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort inflate/extract/unzip calls prior to completion. If HeartbeatMs is 0 (the default), no AbortCheck event callbacks will fire.

top
IsAesEncrypted
BOOL CkZipEntry_getIsAesEncrypted(HCkZipEntry cHandle);
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 CkZipEntry_getIsDirectory(HCkZipEntry cHandle);

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

top
LastErrorHtml
void CkZipEntry_getLastErrorHtml(HCkZipEntry cHandle, HCkString retval);
const char *CkZipEntry_lastErrorHtml(HCkZipEntry cHandle);

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
void CkZipEntry_getLastErrorText(HCkZipEntry cHandle, HCkString retval);
const char *CkZipEntry_lastErrorText(HCkZipEntry cHandle);

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
void CkZipEntry_getLastErrorXml(HCkZipEntry cHandle, HCkString retval);
const char *CkZipEntry_lastErrorXml(HCkZipEntry cHandle);

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
BOOL CkZipEntry_getLastMethodSuccess(HCkZipEntry cHandle);
void CkZipEntry_putLastMethodSuccess(HCkZipEntry cHandle, BOOL newVal);

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
TextFlag
BOOL CkZipEntry_getTextFlag(HCkZipEntry cHandle);
void CkZipEntry_putTextFlag(HCkZipEntry cHandle, 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 CkZipEntry_getUncompressedLength(HCkZipEntry cHandle);

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

top
UncompressedLength64
__int64 CkZipEntry_getUncompressedLength64(HCkZipEntry cHandle);

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

top
UncompressedLengthStr
void CkZipEntry_getUncompressedLengthStr(HCkZipEntry cHandle, HCkString retval);
const char *CkZipEntry_uncompressedLengthStr(HCkZipEntry cHandle);

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

top
Utf8
BOOL CkZipEntry_getUtf8(HCkZipEntry cHandle);
void CkZipEntry_putUtf8(HCkZipEntry cHandle, BOOL newVal);

When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.

top
VerboseLogging
BOOL CkZipEntry_getVerboseLogging(HCkZipEntry cHandle);
void CkZipEntry_putVerboseLogging(HCkZipEntry cHandle, 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 CkZipEntry_getVersion(HCkZipEntry cHandle, HCkString retval);
const char *CkZipEntry_version(HCkZipEntry cHandle);

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

More Information and Examples
top

Methods

AppendData
BOOL CkZipEntry_AppendData(HCkZipEntry cHandle, HCkByteData inData);

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

Returns TRUE for success, FALSE for failure.

top
AppendDataAsync (1)
HCkTask CkZipEntry_AppendDataAsync(HCkZipEntry cHandle, HCkByteData inData);

Creates an asynchronous task to call the AppendData method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns NULL on failure

top
AppendString
BOOL CkZipEntry_AppendString(HCkZipEntry cHandle, 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)
HCkTask CkZipEntry_AppendStringAsync(HCkZipEntry cHandle, const char *strContent, const char *charset);

Creates an asynchronous task to call the AppendString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns NULL on failure

top
Copy
BOOL CkZipEntry_Copy(HCkZipEntry cHandle, HCkByteData 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
CopyToBase64
BOOL CkZipEntry_CopyToBase64(HCkZipEntry cHandle, HCkString outStr);
const char *CkZipEntry_copyToBase64(HCkZipEntry cHandle);

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 CkZipEntry_CopyToHex(HCkZipEntry cHandle, HCkString outStr);
const char *CkZipEntry_copyToHex(HCkZipEntry cHandle);

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 CkZipEntry_Extract(HCkZipEntry cHandle, 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)
HCkTask CkZipEntry_ExtractAsync(HCkZipEntry cHandle, const char *dirPath);

Creates an asynchronous task to call the Extract method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns NULL on failure

top
ExtractInto
BOOL CkZipEntry_ExtractInto(HCkZipEntry cHandle, 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)
HCkTask CkZipEntry_ExtractIntoAsync(HCkZipEntry cHandle, const char *dirPath);

Creates an asynchronous task to call the ExtractInto method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns NULL on failure

top
GetDt
HCkDateTime CkZipEntry_GetDt(HCkZipEntry cHandle);

Returns the last-modified date/time of this zip entry.

Returns NULL on failure

top
Inflate
BOOL CkZipEntry_Inflate(HCkZipEntry cHandle, HCkByteData outData);

Inflate a file within a Zip directly into memory.

Returns TRUE for success, FALSE for failure.

top
InflateAsync (1)
HCkTask CkZipEntry_InflateAsync(HCkZipEntry cHandle);

Creates an asynchronous task to call the Inflate method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns NULL on failure

top
LoadTaskCaller
BOOL CkZipEntry_LoadTaskCaller(HCkZipEntry cHandle, HCkTask 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
NextEntry
HCkZipEntry CkZipEntry_NextEntry(HCkZipEntry cHandle);

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

Returns NULL on failure

top
NextMatchingEntry
HCkZipEntry CkZipEntry_NextMatchingEntry(HCkZipEntry cHandle, const char *matchStr);
Introduced in version 9.5.0.50

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

Returns NULL on failure

More Information and Examples
top
ReplaceData
BOOL CkZipEntry_ReplaceData(HCkZipEntry cHandle, HCkByteData inData);

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

Returns TRUE for success, FALSE for failure.

top
ReplaceString
BOOL CkZipEntry_ReplaceString(HCkZipEntry cHandle, 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
top
SetDt
void CkZipEntry_SetDt(HCkZipEntry cHandle, HCkDateTime dt);

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

top
UnzipToBd
BOOL CkZipEntry_UnzipToBd(HCkZipEntry cHandle, HCkBinData 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)
HCkTask CkZipEntry_UnzipToBdAsync(HCkZipEntry cHandle, HCkBinData binData);
Introduced in version 9.5.0.67

Creates an asynchronous task to call the UnzipToBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns NULL on failure

top
UnzipToSb
BOOL CkZipEntry_UnzipToSb(HCkZipEntry cHandle, int lineEndingBehavior, const char *srcCharset, HCkStringBuilder 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)
HCkTask CkZipEntry_UnzipToSbAsync(HCkZipEntry cHandle, int lineEndingBehavior, const char *srcCharset, HCkStringBuilder sb);
Introduced in version 9.5.0.67

Creates an asynchronous task to call the UnzipToSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns NULL on failure

top
UnzipToStream
BOOL CkZipEntry_UnzipToStream(HCkZipEntry cHandle, HCkStream 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
top
UnzipToStreamAsync (1)
HCkTask CkZipEntry_UnzipToStreamAsync(HCkZipEntry cHandle, HCkStream toStream);
Introduced in version 9.5.0.67

Creates an asynchronous task to call the UnzipToStream method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns NULL on failure

More Information and Examples
top
UnzipToString
BOOL CkZipEntry_UnzipToString(HCkZipEntry cHandle, int lineEndingBehavior, const char *srcCharset, HCkString outStr);
const char *CkZipEntry_unzipToString(HCkZipEntry cHandle, 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.

top
UnzipToStringAsync (1)
HCkTask CkZipEntry_UnzipToStringAsync(HCkZipEntry cHandle, int lineEndingBehavior, const char *srcCharset);

Creates an asynchronous task to call the UnzipToString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns NULL on failure

top