Log Xojo Plugin Reference Documentation

Log

Current Version: 10.1.2

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

Object Creation

Dim log As New Chilkat.Log

Properties

DebugLogFilePath
DebugLogFilePath As String

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
top
LastErrorHtml
LastErrorHtml As String (read-only)

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
LastErrorText As String (read-only)

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
LastErrorXml As String (read-only)

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
LastMethodSuccess As Boolean

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
VerboseLogging As Boolean

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
Version As String (read-only)

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

More Information and Examples
top

Methods

Clear
Sub Clear(initialTag As String)
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
Sub EnterContext(tag As String)
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
top
LeaveContext
Sub 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
Sub LogData(tag As String, message As String)
Introduced in version 9.5.0.44

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

top
LogDataBase64
Sub LogDataBase64(tag As String, data As MemoryBlock)
Introduced in version 9.5.0.44

Logs binary data in base64 format.

top
LogDataHex
Sub LogDataHex(tag As String, data As MemoryBlock)
Introduced in version 9.5.0.44

Logs binary data in hex format.

top
LogDataMax
Sub LogDataMax(tag As String, message As String, maxNumChars As Int32)
Introduced in version 9.5.0.44

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

top
LogDateTime
Sub LogDateTime(tag As String, gmt As Boolean)
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
Sub LogError(message As String)
Introduced in version 9.5.0.44

Logs an error within the current context.

top
LogInfo
Sub LogInfo(message As String)
Introduced in version 9.5.0.44

Logs an informational message within the current context.

top
LogInt
Sub LogInt(tag As String, value As Int32)
Introduced in version 9.5.0.44

Logs an integer.

top
LogInt64
Sub LogInt64(tag As String, value As Int64)
Introduced in version 9.5.0.44

Logs a 64-bit integer.

top
LogTimestamp
Sub LogTimestamp(tag As String)
Introduced in version 9.5.0.44

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

top