ZipEntry C Reference Documentation

ZipEntry

Current Version: 11.4.0
Requires Chilkat Bundle License

The Chilkat.ZipEntry class represents a single entry contained within a Chilkat.Zip object.

For a more complete introduction and conceptual overview, see:

ZipEntry Overview

A ZipEntry may represent:

  • A file already contained within an opened ZIP archive
  • A referenced filesystem file that has not yet been compressed
  • An in-memory data entry containing text or binary data
  • A directory entry

ZipEntry objects provide access to ZIP entry metadata such as:

  • Filename and stored ZIP path
  • Compressed and uncompressed sizes
  • Compression method and compression level
  • Encryption information
  • Last-modified timestamps
  • CRC values and entry attributes

ZipEntry objects can also be used to:

  • Extract individual entries
  • Inflate entry contents directly into memory
  • Replace or append entry data
  • Iterate through ZIP archive entries
  • Access compressed entry data

A ZipEntry object is typically obtained from a Chilkat.Zip object using methods such as EntryAt, EntryOf, EntryMatching, or FirstEntry.

The EntryType property indicates the current state of the entry, such as whether it is a mapped entry from an existing ZIP, a referenced filesystem file awaiting compression, or an in-memory data entry.

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

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.

See Also:C Example using Callback Functions

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

Gets or sets the comment stored in the ZIP archive for this entry.

top
CompressedLength
unsigned long CkZipEntry_getCompressedLength(HCkZipEntry cHandle);

The compressed size of this entry, in bytes.

For mapped entries (entries already contained within an opened ZIP archive), this property contains the actual compressed size stored within the ZIP.

For file entries or data entries that have not yet been written to a ZIP archive, compression has not yet occurred. In these cases, this property contains:

  • The current uncompressed data size for data entries.
  • The cached filesystem file size for referenced file entries.

After the ZIP archive is written, the entries become mapped entries, and this property then reflects the actual compressed size stored in the ZIP archive.

top
CompressedLength64
__int64 CkZipEntry_getCompressedLength64(HCkZipEntry cHandle);

The compressed size of this entry, in bytes, as a 64-bit integer.

For mapped entries (entries already contained within an opened ZIP archive), this property contains the actual compressed size stored within the ZIP.

For file entries or data entries that have not yet been written to a ZIP archive, compression has not yet occurred. In these cases, this property contains:

  • The current uncompressed data size for data entries.
  • The cached filesystem file size for referenced file entries.

After the ZIP archive is written, the entries become mapped entries, and this property then reflects the actual compressed size stored in the ZIP archive.

Use this property when sizes may exceed the range of a 32-bit integer.

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

The compressed size of this entry as a decimal string.

For mapped entries (entries already contained within an opened ZIP archive), this property contains the actual compressed size stored within the ZIP.

For file entries or data entries that have not yet been written to a ZIP archive, compression has not yet occurred. In these cases, this property contains:

  • The current uncompressed data size for data entries.
  • The cached filesystem file size for referenced file entries.

After the ZIP archive is written, the entries become mapped entries, and this property then reflects the actual compressed size stored in the ZIP archive.

This property is useful when sizes may exceed the range of a 32-bit integer.

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

Gets or sets the compression level for this entry.

A value of 0 means no compression, and a value of 9 means maximum compression.

The default value is 6.

top
CompressionMethod
int CkZipEntry_getCompressionMethod(HCkZipEntry cHandle);
void CkZipEntry_putCompressionMethod(HCkZipEntry cHandle, int newVal);

Gets or sets the compression method used for this entry.

  • 0 means no compression.
  • 8 means Deflate compression.

Deflate is the standard compression algorithm used by common ZIP utilities such as WinZip.

top
Crc
int CkZipEntry_getCrc(HCkZipEntry cHandle);

The CRC value for this ZIP entry.

For AES-encrypted entries, the CRC value is 0.

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, 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 CkZipEntry_getEncryptionKeyLen(HCkZipEntry cHandle);
Introduced in version 9.5.0.69

The AES encryption key length for this entry.

If this entry is AES encrypted, the value is 128, 192, or 256.

If this entry is not AES encrypted, the value is 0.

top
EntryID
int CkZipEntry_getEntryID(HCkZipEntry cHandle);

A unique identifier assigned to this entry while the ZIP object is instantiated in memory.

This ID can be used to retrieve the same entry later with Zip.EntryById.

top
EntryType
int CkZipEntry_getEntryType(HCkZipEntry cHandle);

Indicates the origin and current state of this ZIP entry.

  • 0 — Mapped Entry: an entry that already exists in an open ZIP file.
  • 1 — File Entry: a file in the local filesystem that has been referenced, but not yet read or compressed.
  • 2 — Data Entry: an entry containing uncompressed data already held in memory.
  • 3 — Null Entry: an entry that no longer exists in the ZIP archive.
  • 4 — New Directory Entry: a directory entry added to the ZIP object.

When the ZIP archive is written by calling WriteZip or WriteToMemory, entries are transformed into mapped entries. In other words, after writing, they point to compressed data contained in the newly created or rewritten ZIP archive.

More Information and Examples
Understanding ZIP Entry Types and the ZIP Object Lifecycle
top
FileDateTimeStr
void CkZipEntry_getFileDateTimeStr(HCkZipEntry cHandle, HCkString retval);
void CkZipEntry_putFileDateTimeStr(HCkZipEntry cHandle, const char *newVal);
const char *CkZipEntry_fileDateTimeStr(HCkZipEntry cHandle);

Gets or sets the local last-modified date/time for this ZIP entry in RFC 822 string format.

Example RFC 822 date/time strings:

Tue, 15 Nov 1994 12:45:26 GMT
Fri, 05 Jan 2024 18:30:00 -0500

The timezone may be specified either as a named timezone such as GMT, or as a numeric UTC offset such as -0500.

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

Gets or sets the filename, including any relative path, stored for this entry inside the ZIP archive.

Changing this property changes the path/name that will appear in the ZIP archive. It does not rename a source file in the local filesystem.

More Information and Examples
Set Entry Filepath (in output Zip) when Zipping
top
FileNameHex
void CkZipEntry_getFileNameHex(HCkZipEntry cHandle, HCkString retval);
const char *CkZipEntry_fileNameHex(HCkZipEntry cHandle);

Returns the raw filename bytes found in the ZIP entry, encoded as a hexadecimal string.

This can be useful for diagnosing filename encoding issues.

top
HeartbeatMs
int CkZipEntry_getHeartbeatMs(HCkZipEntry cHandle);
void CkZipEntry_putHeartbeatMs(HCkZipEntry cHandle, 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 CkZipEntry_getIsAesEncrypted(HCkZipEntry cHandle);
Introduced in version 9.5.0.69

Indicates whether this ZIP entry is AES encrypted.

This property can be TRUE only for entries already contained in a ZIP archive, such as entries obtained after calling OpenZip, OpenBd, or OpenFromMemory.

If the entry is not AES encrypted, the property is FALSE.

top
IsDirectory
BOOL CkZipEntry_getIsDirectory(HCkZipEntry cHandle);

Indicates whether this ZIP entry is a directory entry.

The value is TRUE if the entry represents a directory, and FALSE if it represents a file.

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

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 CkZipEntry_getLastErrorText(HCkZipEntry cHandle, HCkString retval);
const char *CkZipEntry_lastErrorText(HCkZipEntry cHandle);

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 CkZipEntry_getLastErrorXml(HCkZipEntry cHandle, HCkString retval);
const char *CkZipEntry_lastErrorXml(HCkZipEntry cHandle);

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 CkZipEntry_getLastMethodSuccess(HCkZipEntry cHandle);
void CkZipEntry_putLastMethodSuccess(HCkZipEntry cHandle, 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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

top
TextFlag
BOOL CkZipEntry_getTextFlag(HCkZipEntry cHandle);
void CkZipEntry_putTextFlag(HCkZipEntry cHandle, BOOL newVal);

Gets or sets the text flag in the internal file attributes for this ZIP entry.

This flag indicates whether the entry contents should be considered text rather than binary data.

The flag is informational and does not need to be accurate for normal ZIP processing. It is provided for compatibility with applications that may be sensitive to this attribute.

top
UncompressedLength
unsigned long CkZipEntry_getUncompressedLength(HCkZipEntry cHandle);

The uncompressed size of this entry, in bytes.

top
UncompressedLength64
__int64 CkZipEntry_getUncompressedLength64(HCkZipEntry cHandle);

The uncompressed size of this entry, in bytes, as a 64-bit integer.

Use this property when the uncompressed size may exceed the range of a 32-bit integer.

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

The uncompressed size of this ZIP entry as a decimal string.

This is useful when the uncompressed size may be larger than what can safely be represented by a 32-bit integer.

top
Utf8
BOOL CkZipEntry_getUtf8(HCkZipEntry cHandle);
void CkZipEntry_putUtf8(HCkZipEntry cHandle, 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 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 "10.1.0"

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

Methods

AppendString
BOOL CkZipEntry_AppendString(HCkZipEntry cHandle, const char *strContent, const char *charset);

Appends text data to this ZIP entry's file contents.

The text is converted to bytes using the character encoding specified by charset, such as utf-8, utf-16, or ansi.

If this entry is already a Data Entry (EntryType = 2), then the encoded bytes are appended directly to the existing uncompressed in-memory data.

If this entry is not already a Data Entry, then the entry is first converted into a Data Entry before the new text data is appended.

  • If the entry is a mapped entry (EntryType = 0), the compressed ZIP entry data is first inflated into memory. The new text data is then appended, and the entry becomes a Data Entry containing the combined uncompressed data.
  • If the entry is a file entry (EntryType = 1), the referenced filesystem file is first loaded into memory. The new text data is then appended, and the entry becomes a Data Entry containing the combined data.

After this method is called, the entry contents exist entirely as uncompressed in-memory data associated with the ZipEntry object.

Returns TRUE for success, FALSE for failure.

More Information and Examples
Append Text Data to an Existing ZIP Entry Using ZipEntry.AppendString
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.

Returns NULL on failure

top
CopyToBase64
BOOL CkZipEntry_CopyToBase64(HCkZipEntry cHandle, HCkString outStr);
const char *CkZipEntry_copyToBase64(HCkZipEntry cHandle);

Returns the compressed data for this ZIP entry as a Base64-encoded string.

This method can only be used when the entry already contains compressed data, meaning the entry is a mapped entry.

This is possible for entries from a ZIP archive that has already been opened, or after writing a ZIP archive while it remains open.

Returns TRUE for success, FALSE for failure.

More Information and Examples
Get Compressed ZIP Entry Data as Base64 Using ZipEntry.CopyToBase64
top
CopyToHex
BOOL CkZipEntry_CopyToHex(HCkZipEntry cHandle, HCkString outStr);
const char *CkZipEntry_copyToHex(HCkZipEntry cHandle);

Returns the compressed data for this ZIP entry as a hexadecimal encoded string.

This method can only be used when the entry already contains compressed data, meaning the entry is a mapped entry.

This is possible for entries from a ZIP archive that has already been opened, or after writing a ZIP archive while it remains open.

Returns TRUE for success, FALSE for failure.

top
Extract
BOOL CkZipEntry_Extract(HCkZipEntry cHandle, const char *dirPath);

Extracts this ZIP entry beneath the specified base directory.

The entry is extracted according to the relative path stored in the ZIP archive.

For example, if the entry filename is docs/readme.txt and dirPath is c:/temp/output, the file is extracted to c:/temp/output/docs/readme.txt.

Use ExtractInto instead if the file should be extracted directly into a specific directory regardless of the path stored in the ZIP archive.

Returns TRUE for success, FALSE for failure.

More Information and Examples
Extract a Single ZIP Entry While Preserving Its Stored Path
top
ExtractAsync (1)
HCkTask CkZipEntry_ExtractAsync(HCkZipEntry cHandle, const char *dirPath);

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

Returns NULL on failure

top
ExtractInto
BOOL CkZipEntry_ExtractInto(HCkZipEntry cHandle, const char *dirPath);

Extracts this entry directly into the specified directory, ignoring any path information stored in the ZIP entry.

For example, if the entry filename is docs/readme.txt and dirPath is c:/temp/output, the file is extracted to c:/temp/output/readme.txt.

If this entry is a directory entry, nothing is extracted. To create the directory represented by a directory entry, use Extract instead.

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.

Returns NULL on failure

top
GetNext
BOOL CkZipEntry_GetNext(HCkZipEntry cHandle);
Introduced in version 11.0.0

Updates this ZipEntry object so that it represents the next entry in the same ZIP archive.

The next entry may be either a file entry or a directory entry.

Returns TRUE if the object was advanced to the next entry. Returns FALSE if there are no more entries.

More Information and Examples
Iterate Through ZIP Entries Using EntryAt and ZipEntry.GetNext
top
GetNextMatch
BOOL CkZipEntry_GetNextMatch(HCkZipEntry cHandle, const char *pattern);
Introduced in version 11.0.0

Updates this ZipEntry object so that it represents the next entry in the ZIP archive matching the specified wildcard pattern.

The wildcard character * matches zero or more characters. Matching is performed against the full stored filename, including any relative path.

The matching entry may be either a file entry or a directory entry.

Returns TRUE if a matching entry is found. Returns FALSE if no further matching entry exists.

More Information and Examples
Iterate Through Matching ZIP Entries Using EntryMatching and ZipEntry.GetNextMatch
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
ReplaceString
BOOL CkZipEntry_ReplaceString(HCkZipEntry cHandle, const char *strContent, const char *charset);

Replaces this ZIP entry's existing contents with new text data.

The text is converted to bytes using the character encoding specified by charset, such as utf-8 or ansi.

The resulting bytes become the complete contents of the entry.

Returns TRUE for success, FALSE for failure.

More Information and Examples
Replace/Update a FIle in a .zip
top
SetDt
void CkZipEntry_SetDt(HCkZipEntry cHandle, HCkDateTime dt);

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

The dt argument is a CkDateTime object containing the date/time to store for the entry.

top
UnzipToBd
BOOL CkZipEntry_UnzipToBd(HCkZipEntry cHandle, HCkBinData binData);
Introduced in version 9.5.0.67

Unzips this entry directly into a BinData object.

The uncompressed bytes are written to binData.

Returns TRUE for success, FALSE for failure.

More Information and Examples
Unzip a ZIP Entry Directly into a BinData Object Using ZipEntry.UnzipToBd
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.

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 this entry as text and appends the result to a StringBuilder.

The srcCharset argument specifies how the uncompressed bytes should be interpreted, such as utf-8, utf-16, or windows-1252.

The lineEndingBehavior argument controls line-ending conversion:

  • 0 — leave line endings unchanged.
  • 1 — convert all line endings to bare LF.
  • 2 — convert all line endings to CRLF.

Returns TRUE for success, FALSE for failure.

More Information and Examples
Unzip a Text File Entry into a StringBuilder Using ZipEntry.UnzipToSb
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.

Returns NULL on failure

top
UnzipToStream
BOOL CkZipEntry_UnzipToStream(HCkZipEntry cHandle, HCkStream toStream);
Introduced in version 9.5.0.67

Unzips this entry to a stream.

If called synchronously, the toStream must have a sink, such as a file or another stream object.

If called asynchronously, the foreground thread can read from the stream while the unzip operation writes to it.

Returns TRUE for success, FALSE for failure.

More Information and Examples
Unzip Binary File to Stream
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.

Returns NULL on failure

More Information and Examples
Unzip One File to a Stream
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);

Inflates this entry and returns the uncompressed data as a string.

The srcCharset argument specifies how the uncompressed bytes should be interpreted, such as utf-8, utf-16, or windows-1252.

The lineEndingBehavior argument controls line-ending conversion:

  • 0 — leave line endings unchanged.
  • 1 — convert all line endings to bare LF.
  • 2 — convert all line endings to CRLF.

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)
HCkTask CkZipEntry_UnzipToStringAsync(HCkZipEntry cHandle, int lineEndingBehavior, const char *srcCharset);

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

Returns NULL on failure

top

Deprecated

AppendData Deprecated
BOOL CkZipEntry_AppendData(HCkZipEntry cHandle, HCkByteData inData);

Appends binary data to this ZIP entry's file contents.

If this entry is already a Data Entry (EntryType = 2), then the bytes in inData are appended directly to the existing uncompressed in-memory data.

If this entry is not already a Data Entry, then the entry is first converted into a Data Entry before the new data is appended.

  • If the entry is a mapped entry (EntryType = 0), the compressed ZIP entry data is first inflated into memory. The new data is then appended, and the entry becomes a Data Entry containing the combined uncompressed data.
  • If the entry is a file entry (EntryType = 1), the referenced filesystem file is first loaded into memory. The new data is then appended, and the entry becomes a Data Entry containing the combined data.

After this method is called, the entry contents exist entirely as uncompressed in-memory data associated with the ZipEntry object.

Returns TRUE for success, FALSE for failure.

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

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

Returns NULL on failure

top
Copy Deprecated
BOOL CkZipEntry_Copy(HCkZipEntry cHandle, HCkByteData outData);

Returns the compressed data for this ZIP entry as a byte array.

This method can only be called when the entry already contains compressed data. In other words, the entry must be a mapped entry.

This is the case when an existing ZIP archive has been opened, or after a ZIP archive has been written using WriteZip or WriteToMemory.

If the entry was added using methods such as AppendData, AppendFiles, or AddFile, it does not yet contain compressed data. The entry becomes a mapped entry after the ZIP archive is written.

Returns TRUE for success, FALSE for failure.

top
GetDt
HCkDateTime CkZipEntry_GetDt(HCkZipEntry cHandle);
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.

Returns NULL on failure

More Information and Examples
Transition from ZipEntry.GetDt to ZipEntry.FileDateTimeStr
top
Inflate Deprecated
BOOL CkZipEntry_Inflate(HCkZipEntry cHandle, HCkByteData outData);

Inflates this ZIP entry directly into memory and returns the uncompressed data as a byte array.

This method is used to obtain the uncompressed bytes of a single ZIP entry without extracting it to a file.

Returns TRUE for success, FALSE for failure.

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

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

Returns NULL on failure

top
NextEntry
HCkZipEntry CkZipEntry_NextEntry(HCkZipEntry cHandle);
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

Returns NULL on failure

More Information and Examples
Transition from ZipEntry.NextEntry to ZipEntry.GetNextList Files in Zip using FirstEntry/NextEntry
top
NextMatchingEntry
HCkZipEntry CkZipEntry_NextMatchingEntry(HCkZipEntry cHandle, 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.

Returns NULL on failure

More Information and Examples
Iterate over Matching Filenames
top
ReplaceData Deprecated
BOOL CkZipEntry_ReplaceData(HCkZipEntry cHandle, HCkByteData inData);

Replaces this ZIP entry's existing contents with new binary data.

The new data becomes the complete contents of the entry.

Returns TRUE for success, FALSE for failure.

top