ZipEntry Swift Reference Documentation
CkoZipEntry
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).
Object Creation
let obj = CkoZipEntry()!
Properties
Comment
The comment stored within the Zip for this entry.
topCompressedLength
The size in bytes of this entry's file data when compression is applied
topCompressedLengthStr
The size in decimal string format of this file when Zip compression is applied.
topCompressionLevel
The compression level. 0 = no compression, while 9 = maximum compression. The default is 6.
topCompressionMethod
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
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.
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
The local last-modified date/time in RFC822 string format.
topFileName
FileNameHex
A string containing the hex encoded raw filename bytes found in the Zip entry.
topHeartbeatMs
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
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
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.
topTextFlag
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.
topUncompressedLengthStr
The size in bytes (in decimal string format) of this zip entry's data when uncompressed.
topVerboseLogging
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
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.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil 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.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil 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 nil on failure
topCopyToBase64
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 nil on failure
topCopyToHex
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 nil on 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.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil 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.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topGetDt
Inflate
Inflate a file within a Zip directly into memory.
Returns nil on failure
InflateAsync (1)
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.
Returns nil on failure
topLoadTaskCaller
NextEntry
Return the next entry (file or directory) within the Zip
Returns nil 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 nil 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.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil 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.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil 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.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
UnzipToString
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 nil on failure
UnzipToStringAsync (1)
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.
Returns nil on failure
topEvents
To implement an event callback, your application would define and implement a class that inherits from CkoBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkoBaseProgress base class.
For example:
class MyZipEntryProgress : CkoBaseProgress {
override func ProgressInfo(name: String!, value: String!) {
// application code goes here...
print(name + ": " + value)
}
override func AbortCheck(abort: UnsafeMutablePointer) {
// application code goes here...
// To abort the operation, set this equal to true instead of false.
abort.memory = false
}
override func PercentDone(pctDone: NSNumber!, abort: UnsafeMutablePointer) {
// application code goes here...
print(pctDone)
// To abort the operation, set this equal to true instead of false.
abort.memory = false
}
// For asynchronous method calls.
override func TaskCompleted(task: CkoTask!) {
// application code goes here...
}
}
func someAppFunction() {
// Demonstrate how to set the event callback object...
let zipentry = CkoZipEntry()
let myZipEntryProgress = MyZipEntryProgress()
zipentry.setEventCallbackObject(myZipEntryProgress)
// ...
// ...
// ...
}
AbortCheck
Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.
PercentDone
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 event is only fired 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 operations (Chilkat method calls) 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).
The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.
The abort output argument provides a means for aborting the operation. Setting it to true will cause the method to abort and return a failed status (or whatever return value indicates failure).
ProgressInfo
A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.
TaskCompleted
Called in the background thread when an asynchronous task completes.