ZipCrc Objective-C Reference Documentation

CkoZipCrc

Current Version: 11.1.0

Calculate a Zip CRC checksum for a file or in-memory data.

Object Creation

CkoZipCrc *obj = [[CkoZipCrc alloc] init];

Properties

DebugLogFilePath
@property (nonatomic, copy) NSString *DebugLogFilePath;

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
top
LastErrorHtml
@property (nonatomic, readonly, copy) NSString *LastErrorHtml;

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
@property (nonatomic, readonly, copy) NSString *LastErrorText;

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.

top
LastErrorXml
@property (nonatomic, readonly, copy) NSString *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.

top
LastMethodSuccess
@property (nonatomic) BOOL LastMethodSuccess;

Indicates the success or failure of the most recent method call: YES means success, NO 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.

top
VerboseLogging
@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.

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

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

More Information and Examples
top

Methods

BeginStream
- (void)BeginStream;

Provides a way to calculate a CRC by streaming the data a chunk at a time. An application would start by calling BeginStream. Then it would add data by calling MoreData for each additional chunk. After the last chunk has been processed, the EndStream method is called to return the CRC.

top
CalculateCrc
- (NSNumber *)CalculateCrc:(NSData *)data;

Calculates a 32-bit CRC for in-memory byte data. This is the 32-bit CRC that would be found in a Zip file header if a file containing the data was added to a zip archive. Returns the CRC32 of the data.

top
CrcBd
- (NSNumber *)CrcBd:(CkoBinData *)bd;
Introduced in version 9.5.0.75

Calculates a CRC32 for the bytes contained in bd.

top
CrcSb
- (NSNumber *)CrcSb:(CkoStringBuilder *)sb
    charset:(NSString *)charset;
Introduced in version 9.5.0.75

Calculates a CRC32 for the string contained in sb. The charset is the byte representation to be used for the sb when calculating the CRC32. It can be utf-8, utf-16, windows-1252, iso-8859-1, or any of the character encodings (charsets) listed at the link below.

top
CrcString
- (NSNumber *)CrcString:(NSString *)str
    charset:(NSString *)charset;
Introduced in version 9.5.0.75

Calculates a CRC32 for a string. The charset is the byte representation to be used for the str when calculating the CRC32. It can be utf-8, utf-16, windows-1252, iso-8859-1, or any of the character encodings (charsets) listed at the link below.

top
EndStream
- (NSNumber *)EndStream;

Finalizes and returns the Zip CRC value calculated by calling BeginStream followed by multiple calls to MoreData.

top
FileCrc
- (NSNumber *)FileCrc:(NSString *)path;

Calculates the CRC32 of a file. The data contained in the file is streamed for the calculation to keep the memory footprint small and constant. Returns the CRC32 of the file.

More Information and Examples
top
FileCrcAsync (1)
- (CkoTask *)FileCrcAsync:(NSString *)path;

Creates an asynchronous task to call the FileCrc 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

top
LoadTaskCaller
- (BOOL)LoadTaskCaller:(CkoTask *)task;
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns YES for success, NO for failure.

top
MoreData
- (void)MoreData:(NSData *)data;

Adds additional data to the CRC currently being calculated. (See BeginStream for more information.)

top
ToHex
- (NSString *)ToHex:(NSNumber *)crc;

Converts a 32-bit integer to a hex string.

Returns nil on failure

top

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:

  CkoZipCrc *zipcrc = [[CkoZipCrc alloc] init];

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

  [zipcrc setEventCallbackObject:callbackObj];

MyZipCrcProgress interface example:

#import "CkoZipCrcProgress.h"

@interface MyZipCrcProgress : CkoBaseProgress {

}

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

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

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

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

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

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

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

More Information and Examples
top
PercentDone
- (void)PercentDone:(NSNumber *)pctDone
    abort:(BOOL *)abort;

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the abort output argument to YES. This will cause the method to terminate and return a failure status or corresponding failure value.

More Information and Examples
top
ProgressInfo
- (void)ProgressInfo:(NSString *)name
    value:(NSString *)value;

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

More Information and Examples
top
TaskCompleted
- (void)TaskCompleted:(CkoTask *)task;

Called from the background thread when an asynchronous task completes.

top