Log CkPython Reference Documentation

CkLog

Current Version: 10.1.2

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

Object Creation

obj = chilkat.CkLog()

Properties

DebugLogFilePath

# 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, 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

Example showing how to use DebugLogFilePath.

LastErrorHtml

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

LastErrorText

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

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

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

LastMethodSuccess

# boolVal is a boolean
boolVal = log.get_LastMethodSuccess();
log.put_LastMethodSuccess(boolVal);

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.

Utf8

# boolVal is a boolean
boolVal = log.get_Utf8();
log.put_Utf8(boolVal);

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

VerboseLogging

# boolVal is a boolean
boolVal = log.get_VerboseLogging();
log.put_VerboseLogging(boolVal);

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.

Version

# strVal is a string
# ckStr is a CkString
log.get_Version(ckStr);
strVal = log.version();

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

Clear

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

EnterContext

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

More Information and Examples

Enter/Leave Context in Logging

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

LogData

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

LogDataBase64

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

LogDataHex

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

LogDataMax

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

LogDateTime

# 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 True, then the GMT/UTC time is logged. Otherwise it is the local time.

LogError

# message is a string
log.LogError(message);

Introduced in version 9.5.0.44

Logs an error within the current context.

LogInfo

# message is a string
log.LogInfo(message);

Introduced in version 9.5.0.44

Logs an informational message within the current context.

LogInt

# tag is a string
# value is an integer
log.LogInt(tag, value);

Introduced in version 9.5.0.44

Logs an integer.

LogInt64

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

LogTimestamp

# tag is a string
log.LogTimestamp(tag);

Introduced in version 9.5.0.44

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