CkLog Perl Reference Documentation

CkLog

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

Object Creation

$obj = chilkat::CkLog()->new();

Properties

# $strVal is a string
# $ckStr is a CkString
$log->get_DebugLogFilePath($ckStr);
$strVal = $log->debugLogFilePath();
$log->put_DebugLogFilePath($strVal);

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.

# $strVal is a string
# $ckStr is a CkString
$log->get_LastErrorHtml($ckStr);
$strVal = $log->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.

# $strVal is a string
# $ckStr is a CkString
$log->get_LastErrorText($ckStr);
$strVal = $log->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

# $strVal is a string
# $ckStr is a CkString
$log->get_LastErrorXml($ckStr);
$strVal = $log->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.

# $boolVal is a boolean
$boolVal = $log->get_LastMethodSuccess();
$log->put_LastMethodSuccess($boolVal);

Introduced in version 9.5.0.52

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

# $boolVal is a boolean
$boolVal = $log->get_Utf8();
$log->put_Utf8($boolVal);

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

# $boolVal is a boolean
$boolVal = $log->get_VerboseLogging();
$log->put_VerboseLogging($boolVal);

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

# $strVal is a string
# $ckStr is a CkString
$log->get_Version($ckStr);
$strVal = $log->version();

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

Methods

# $initialTag is a string
$log->Clear($initialTag);

Introduced in version 9.5.0.44

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

# $tag is a string
$log->EnterContext($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.

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

# $tag is a string
# $message is a string
$log->LogData($tag, $message);

Introduced in version 9.5.0.44

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

# $tag is a string
# $data is a CkByteData
$log->LogDataBase64($tag, $data);

Introduced in version 9.5.0.44

Logs binary data in base64 format.

# $tag is a string
# $data is a CkByteData
$log->LogDataHex($tag, $data);

Introduced in version 9.5.0.44

Logs binary data in hex format.

# $tag is a string
# $message is a string
# $maxNumChars is an integer
$log->LogDataMax($tag, $message, $maxNumChars);

Introduced in version 9.5.0.44

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

# $tag is a string
# $gmt is a boolean
$log->LogDateTime($tag, $gmt);

Introduced in version 9.5.0.44

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

# $message is a string
$log->LogError($message);

Introduced in version 9.5.0.44

Logs an error within the current context.

# $message is a string
$log->LogInfo($message);

Introduced in version 9.5.0.44

Logs an informational message within the current context.

# $tag is a string
# $value is an integer
$log->LogInt($tag, $value);

Introduced in version 9.5.0.44

Logs an integer.

# $tag is a string
# $value is a 64-bit integer
$log->LogInt64($tag, $value);

Introduced in version 9.5.0.44

Logs a 64-bit integer.

# $tag is a string
$log->LogTimestamp($tag);

Introduced in version 9.5.0.44

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

# $path is a string
$status = $log->SaveLastError($path);

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

Returns 1 for success, 0 for failure.