Log PureBasic Reference Documentation

Log

Current Version: 9.5.0.75

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

Object Creation

obj.i = CkLog::ckCreate()

; Make sure to dispose of the object when finished like this:
CkLog::ckDispose(obj);

Properties

DebugLogFilePath
Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

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
Declare.s ckLastErrorHtml(obj.i) ; (read-only)

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
Declare.s ckLastErrorText(obj.i) ; (read-only)

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
Declare.s ckLastErrorXml(obj.i) ; (read-only)

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
Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)
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.

top
VerboseLogging
Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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.

top
Version
Declare.s ckVersion(obj.i) ; (read-only)

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

top

Methods

Clear
Declare ckClear(obj.i, initialTag.s)
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
Declare ckEnterContext(obj.i, tag.s)
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
Declare ckLeaveContext(obj.i)
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
Declare ckLogData(obj.i, tag.s, message.s)
Introduced in version 9.5.0.44

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

top
LogDataMax
Declare ckLogDataMax(obj.i, tag.s, message.s, maxNumChars.l)
Introduced in version 9.5.0.44

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

top
LogDateTime
Declare ckLogDateTime(obj.i, tag.s, gmt.l)
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.

top
LogError
Declare ckLogError(obj.i, message.s)
Introduced in version 9.5.0.44

Logs an error within the current context.

top
LogInfo
Declare ckLogInfo(obj.i, message.s)
Introduced in version 9.5.0.44

Logs an informational message within the current context.

top
LogInt
Declare ckLogInt(obj.i, tag.s, value.l)
Introduced in version 9.5.0.44

Logs an integer.

top
LogInt64
Declare ckLogInt64(obj.i, tag.s, value.q)
Introduced in version 9.5.0.44

Logs a 64-bit integer.

top
LogTimestamp
Declare ckLogTimestamp(obj.i, tag.s)
Introduced in version 9.5.0.44

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

top
SaveLastError
Declare.i ckSaveLastError(obj.i, path.s)

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

Returns 1 for success, 0 for failure.

top