Log Objective-C Reference Documentation

CkoLog

Current Version: 10.1.2

Handy logging class exposing much of the functionality used internally by Chilkat for LastErrorText, LastErrorXml, and LastErrorHtml.

Object Creation

CkoLog *obj = [[CkoLog 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

Clear
- (void)Clear:(NSString *)initialTag;
Introduced in version 9.5.0.44

Clears the log. The initialTag is the initial top-level context tag for the new log.

top
EnterContext
- (void)EnterContext:(NSString *)tag;
Introduced in version 9.5.0.44

Enters a new context labelled with the given tag. Must be paired with a matching call to LeaveContext.

More Information and Examples
top
LeaveContext
- (void)LeaveContext;
Introduced in version 9.5.0.44

Leaves the current context. A context that is entered and exited without any logging within the context is automatically removed from the log. (To say it another way: Empty contexts are automaticallly removed from the log upon leaving the context.)

top
LogData
- (void)LogData:(NSString *)tag
    message:(NSString *)message;
Introduced in version 9.5.0.44

Adds a tagged message to the log (i.e. a name/value pair).

top
LogDataBase64
- (void)LogDataBase64:(NSString *)tag
    data:(NSData *)data;
Introduced in version 9.5.0.44

Logs binary data in base64 format.

top
LogDataBase64_2
- (void)LogDataBase64_2:(NSString *)tag
    pByteData:(NSData *)pByteData
    szByteData:(NSNumber *)szByteData;
Introduced in version 9.5.0.82

Logs binary data in base64 format.

top
LogDataHex
- (void)LogDataHex:(NSString *)tag
    data:(NSData *)data;
Introduced in version 9.5.0.44

Logs binary data in hex format.

top
LogDataHex2
- (void)LogDataHex2:(NSString *)tag
    pByteData:(NSData *)pByteData
    szByteData:(NSNumber *)szByteData;
Introduced in version 9.5.0.82

Logs binary data in hex format.

top
LogDataMax
- (void)LogDataMax:(NSString *)tag
    message:(NSString *)message
    maxNumChars:(NSNumber *)maxNumChars;
Introduced in version 9.5.0.44

Logs a string, but only up to the 1st maxNumChars characters of the string.

top
LogDateTime
- (void)LogDateTime:(NSString *)tag
    gmt:(BOOL)gmt;
Introduced in version 9.5.0.44

Logs the current date/time in RFC822 format. If gmt is YES, then the GMT/UTC time is logged. Otherwise it is the local time.

top
LogError
- (void)LogError:(NSString *)message;
Introduced in version 9.5.0.44

Logs an error within the current context.

top
LogHash2
- (void)LogHash2:(NSString *)tag
    hashAlg:(NSString *)hashAlg
    pByteData:(NSData *)pByteData
    szByteData:(NSNumber *)szByteData;
Introduced in version 9.5.0.82

Logs the hash of binary data in hex format. The tag can be SHA1, SHA256, SHA384, SHA512, or MD5.

top
LogInfo
- (void)LogInfo:(NSString *)message;
Introduced in version 9.5.0.44

Logs an informational message within the current context.

top
LogInt
- (void)LogInt:(NSString *)tag
    value:(NSNumber *)value;
Introduced in version 9.5.0.44

Logs an integer.

top
LogInt64
- (void)LogInt64:(NSString *)tag
    value:(NSNumber *)value;
Introduced in version 9.5.0.44

Logs a 64-bit integer.

top
LogTimestamp
- (void)LogTimestamp:(NSString *)tag;
Introduced in version 9.5.0.44

Logs the current time in HH:MM:SS:mmm format.

top