ZipEntry Unicode C Reference Documentation
ZipEntry
Current Version: 10.1.0
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
HCkZipEntryW instance = CkZipEntryW_Create(); // ... CkZipEntryW_Dispose(instance);
Creates an instance of the HCkZipEntryW object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkZipEntryW_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 CkZipEntryW_Dispose.
Callback Functions
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.
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.
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.
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 CkZipEntryW_putComment(HCkZipEntryW cHandle, const wchar_t *newVal);
const wchar_t *CkZipEntryW_comment(HCkZipEntryW cHandle);
The comment stored within the Zip for this entry.
topCompressedLength
The size in bytes of this entry's file data when compression is applied
topCompressedLength64
The size in bytes of this entry's file data when compression is applied
topCompressedLengthStr
const wchar_t *CkZipEntryW_compressedLengthStr(HCkZipEntryW cHandle);
The size in decimal string format of this file when Zip compression is applied.
topCompressionLevel
void CkZipEntryW_putCompressionLevel(HCkZipEntryW cHandle, int newVal);
The compression level. 0 = no compression, while 9 = maximum compression. The default is 6.
topCompressionMethod
void CkZipEntryW_putCompressionMethod(HCkZipEntryW 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
topCrc
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 )
topDebugLogFilePath
void CkZipEntryW_putDebugLogFilePath(HCkZipEntryW cHandle, const wchar_t *newVal);
const wchar_t *CkZipEntryW_debugLogFilePath(HCkZipEntryW 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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
EncryptionKeyLen
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.
topEntryID
A unique ID assigned to the entry while the object is instantiated in memory.
topEntryType
Indicates the origin of the entry. There are three possible values:
- Mapped Entry: An entry in an existing Zip file.
- File Entry: A file not yet in memory, but referenced. These entries are added by calling AppendFiles, AppendFilesEx, AppendOneFileOrDir, etc.
- Data Entry: An entry containing uncompressed data from memory. These entries are added by calling AppendData, AppendString, etc.
- Null Entry: An entry that no longer exists in the .zip.
- New Directory Entry: A directory entry added by calling AppendNewDir.
FileDateTimeStr
void CkZipEntryW_putFileDateTimeStr(HCkZipEntryW cHandle, const wchar_t *newVal);
const wchar_t *CkZipEntryW_fileDateTimeStr(HCkZipEntryW cHandle);
The local last-modified date/time in RFC822 string format.
topFileName
void CkZipEntryW_putFileName(HCkZipEntryW cHandle, const wchar_t *newVal);
const wchar_t *CkZipEntryW_fileName(HCkZipEntryW cHandle);
FileNameHex
const wchar_t *CkZipEntryW_fileNameHex(HCkZipEntryW cHandle);
A string containing the hex encoded raw filename bytes found in the Zip entry.
topHeartbeatMs
void CkZipEntryW_putHeartbeatMs(HCkZipEntryW 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.
topIsAesEncrypted
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.
topIsDirectory
True if the Zip entry is a directory, false if it is a file.
topLastErrorHtml
const wchar_t *CkZipEntryW_lastErrorHtml(HCkZipEntryW 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.
topLastErrorText
const wchar_t *CkZipEntryW_lastErrorText(HCkZipEntryW 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.
LastErrorXml
const wchar_t *CkZipEntryW_lastErrorXml(HCkZipEntryW 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.
topLastMethodSuccess
void CkZipEntryW_putLastMethodSuccess(HCkZipEntryW 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.
topTextFlag
void CkZipEntryW_putTextFlag(HCkZipEntryW 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.
topUncompressedLength
The size in bytes of this entry's file data when uncompressed.
topUncompressedLength64
The size in bytes of this entry's file data when uncompressed.
topUncompressedLengthStr
const wchar_t *CkZipEntryW_uncompressedLengthStr(HCkZipEntryW cHandle);
The size in bytes (in decimal string format) of this zip entry's data when uncompressed.
topVerboseLogging
void CkZipEntryW_putVerboseLogging(HCkZipEntryW 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.
topVersion
const wchar_t *CkZipEntryW_version(HCkZipEntryW cHandle);
Methods
AppendData
Appends binary data to the zip entry's file contents.
Returns TRUE for success, FALSE for failure.
topAppendDataAsync (1)
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
topAppendString
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.
topAppendStringAsync (1)
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
topCopy
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.
topCopyToBase64
const wchar_t *CkZipEntryW_copyToBase64(HCkZipEntryW 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.
topCopyToHex
const wchar_t *CkZipEntryW_copyToHex(HCkZipEntryW 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.
topExtract
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.
topExtractAsync (1)
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
topExtractInto
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.
topExtractIntoAsync (1)
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
topGetDt
Inflate
Inflate a file within a Zip directly into memory.
Returns TRUE for success, FALSE for failure.
InflateAsync (1)
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
topLoadTaskCaller
NextEntry
Return the next entry (file or directory) within the Zip
Returns NULL on failure
NextMatchingEntry
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
ReplaceData
Replaces the zip entry's existing contents with new data.
Returns TRUE for success, FALSE for failure.
topReplaceString
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.
SetDt
Sets the last-modified date/time for this zip entry.
topUnzipToBd
UnzipToBdAsync (1)
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
topUnzipToSb
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.
topUnzipToSbAsync (1)
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
topUnzipToStream
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.
UnzipToStreamAsync (1)
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
UnzipToString
const wchar_t *CkZipEntryW_unzipToString(HCkZipEntryW cHandle, int lineEndingBehavior, const wchar_t *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.
UnzipToStringAsync (1)
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