CkLog Python Reference Documentation

CkLog

Current Version: 9.5.0.73

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

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

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

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

top
LastMethodSuccess
# 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 True indicates success, a value of False 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 = True and failure = False.
  • 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 True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

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

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

top
Version
# 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"

top

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.

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

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

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

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

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

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

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

top
LogError
# message is a string
log.LogError(message);
Introduced in version 9.5.0.44

Logs an error within the current context.

top
LogInfo
# message is a string
log.LogInfo(message);
Introduced in version 9.5.0.44

Logs an informational message within the current context.

top
LogInt
# tag is a string
# value is an integer
log.LogInt(tag, value);
Introduced in version 9.5.0.44

Logs an integer.

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

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

top
SaveLastError
# path is a string
status = log.SaveLastError(path);

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

Returns True for success, False for failure.

top