Log Java 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

CkLog obj = new CkLog();

Properties

DebugLogFilePath
void get_DebugLogFilePath(CkString str);
String debugLogFilePath();
void put_DebugLogFilePath(String newVal);

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.

top
LastErrorHtml
void get_LastErrorHtml(CkString str);
String 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
void get_LastErrorText(CkString str);
String 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
void get_LastErrorXml(CkString str);
String 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
boolean get_LastMethodSuccess();
void put_LastMethodSuccess(boolean newVal);

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.

top
VerboseLogging
boolean get_VerboseLogging();
void put_VerboseLogging(boolean newVal);

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
void get_Version(CkString str);
String version();

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

top

Methods

Clear
void Clear(String 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(String 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
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(String tag, String 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(String tag, CkByteData data);
Introduced in version 9.5.0.44

Logs binary data in base64 format.

top
LogDataHex
void LogDataHex(String tag, CkByteData data);
Introduced in version 9.5.0.44

Logs binary data in hex format.

top
LogDataMax
void LogDataMax(String tag, String message, int 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(String tag, boolean 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
void LogError(String message);
Introduced in version 9.5.0.44

Logs an error within the current context.

top
LogInfo
void LogInfo(String message);
Introduced in version 9.5.0.44

Logs an informational message within the current context.

top
LogInt
void LogInt(String tag, int value);
Introduced in version 9.5.0.44

Logs an integer.

top
LogInt64
void LogInt64(String tag, long long value);
Introduced in version 9.5.0.44

Logs a 64-bit integer.

top
LogTimestamp
void LogTimestamp(String tag);
Introduced in version 9.5.0.44

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

top