CkoZipEntry Objective-C Reference Documentation

CkoZipEntry

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

Properties

@property (nonatomic, copy) NSString *Comment;

The comment stored within the Zip for this entry.

@property (nonatomic, readonly, copy) NSNumber *CompressedLength;

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

@property (nonatomic, readonly, copy) NSString *CompressedLengthStr;

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

@property (nonatomic, copy) NSNumber *CompressionLevel;

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

@property (nonatomic, copy) NSNumber *CompressionMethod;

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

@property (nonatomic, readonly, copy) NSNumber *Crc;

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 )

@property (nonatomic, copy) NSString *DebugLogFilePath;

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.

@property (nonatomic, readonly, copy) NSNumber *EncryptionKeyLen;

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.

@property (nonatomic, readonly, copy) NSNumber *EntryID;

The unique ID assigned by Zip.NET while the object is instantiated in memory.

@property (nonatomic, readonly, copy) NSNumber *EntryType;

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

@property (nonatomic, copy) NSDate *FileDateTime;

This property is deprecated. It will be removed in a future version.

The local last-modified date/time.

@property (nonatomic, copy) NSString *FileDateTimeStr;

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

@property (nonatomic, copy) NSString *FileName;

The file name of the Zip entry.

Set Entry Filepath (in output Zip) when Zipping

@property (nonatomic, readonly, copy) NSString *FileNameHex;

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

@property (nonatomic, copy) NSNumber *HeartbeatMs;

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.

@property (nonatomic, readonly) BOOL IsAesEncrypted;

Introduced in version 9.5.0.69

YES if the entry is AES encrypted. This property can only be YES 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 NO if the entry contained in the zip is not AES encrypted.

@property (nonatomic, readonly) BOOL IsDirectory;

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

@property (nonatomic, readonly, copy) NSString *LastErrorHtml;

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.

@property (nonatomic, readonly, copy) NSString *LastErrorText;

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.

Concept of LastErrorText

LastErrorText Standard Information

@property (nonatomic, readonly, copy) NSString *LastErrorXml;

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.

@property (nonatomic) BOOL LastMethodSuccess;

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of YES indicates success, a value of NO 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 = YES and failure = NO.
  • 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 YES. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

@property (nonatomic) BOOL TextFlag;

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.

@property (nonatomic, readonly, copy) NSNumber *UncompressedLength;

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

@property (nonatomic, readonly, copy) NSString *UncompressedLengthStr;

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

@property (nonatomic) BOOL VerboseLogging;

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

@property (nonatomic, readonly, copy) NSString *Version;

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

Methods

- (BOOL)AppendData:(NSData *)bdata;

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

Returns YES for success, NO for failure.

- (CkoTask *)AppendDataAsync:(NSData *)bdata;

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

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

How to Run an Asynchronous Task

- (BOOL)AppendString:(NSString *)inStr
    charset:(NSString *)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 YES for success, NO for failure.

- (CkoTask *)AppendStringAsync:(NSString *)inStr
    charset:(NSString *)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.)

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

How to Run an Asynchronous Task

- (NSData *)Copy;

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

- (NSString *)CopyToBase64;

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

- (NSString *)CopyToHex;

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

- (BOOL)Extract:(NSString *)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 YES for success, NO for failure.

- (CkoTask *)ExtractAsync:(NSString *)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.)

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

How to Run an Asynchronous Task

- (BOOL)ExtractInto:(NSString *)dirPath;

Unzip a file into a specific directory

Returns YES for success, NO for failure.

- (CkoTask *)ExtractIntoAsync:(NSString *)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.)

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

How to Run an Asynchronous Task

- (CkoDateTime *)GetDt;

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

Returns nil on failure

- (NSData *)Inflate;

Inflate a file within a Zip directly into memory.

Returns nil on failure

- (CkoTask *)InflateAsync;

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

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

How to Run an Asynchronous Task

- (CkoZipEntry *)NextEntry;

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

Returns nil on failure

- (CkoZipEntry *)NextMatchingEntry:(NSString *)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 nil on failure

Iterate over Matching Filenames

- (BOOL)ReplaceData:(NSData *)bdata;

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

Returns YES for success, NO for failure.

- (BOOL)ReplaceString:(NSString *)inStr
    charset:(NSString *)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 YES for success, NO for failure.

Replace/Update a FIle in a .zip

- (BOOL)SaveLastError:(NSString *)path;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns YES for success, NO for failure.

- (void)SetDt:(CkoDateTime *)dt;

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

- (BOOL)UnzipToBd:(CkoBinData *)binData;

Introduced in version 9.5.0.67

Unzips the entry contents into the binData.

Returns YES for success, NO for failure.

- (CkoTask *)UnzipToBdAsync:(CkoBinData *)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.)

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

How to Run an Asynchronous Task

- (BOOL)UnzipToSb:(NSNumber *)lineEndingBehavior
    srcCharset:(NSString *)srcCharset
    sb:(CkoStringBuilder *)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 YES for success, NO for failure.

- (CkoTask *)UnzipToSbAsync:(NSNumber *)lineEndingBehavior
    srcCharset:(NSString *)srcCharset
    sb:(CkoStringBuilder *)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.)

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

How to Run an Asynchronous Task

- (BOOL)UnzipToStream:(CkoStream *)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 YES for success, NO for failure.

Unzip Binary File to Stream

- (CkoTask *)UnzipToStreamAsync:(CkoStream *)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.)

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

Unzip One File to a Stream

- (NSString *)UnzipToString:(NSNumber *)lineEndingBehavior
    srcCharset:(NSString *)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 nil on failure

Iterate over Matching Filenames

Download a Zip from a URL and OpenFromMemory. (No .zip fie is created)

- (CkoTask *)UnzipToStringAsync:(NSNumber *)lineEndingBehavior
    srcCharset:(NSString *)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.)

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

How to Run an Asynchronous Task

Events

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:

  CkoZipEntry *zipentry = [[CkoZipEntry alloc] init];

  MyZipEntryProgress *callbackObj = [[MyZipEntryProgress alloc] init];

  [zipentry setEventCallbackObject:callbackObj];

MyZipEntryProgress interface example:

#import "CkoZipEntryProgress.h"

@interface MyZipEntryProgress : CkoBaseProgress {

}

    - (id)init;
    - (void)dealloc;
    - (void)dispose;

    - (void)AbortCheck:(BOOL *)abort;

    - (void)BinaryData:(NSData *)data 
        length:(NSNumber *)length;

    - (void)PercentDone:(NSNumber *)pctDone 
        abort:(BOOL *)abort;

    - (void)ProgressInfo:(NSString *)name 
        value:(NSString *)value;

    - (void)TaskCompleted:(CkoTask *)task;

    - (void)TextData:(NSString *)data;

@end

- (void)AbortCheck:(BOOL *)abort;

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.

- (void)BinaryData:(NSData *)data
    length:(NSNumber *)length;

Binary data provided by certain methods.

- (void)PercentDone:(NSNumber *)pctDone
    abort:(BOOL *)abort;

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 YES will cause the method to abort and return a failed status (or whatever return value indicates failure).

- (void)ProgressInfo:(NSString *)name
    value:(NSString *)value;

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.

- (void)TaskCompleted:(CkoTask *)task;

Called in the background thread when an asynchronous task completes.

- (void)TextData:(NSString *)data;

Text data provided by certain methods.