Log Tcl Reference Documentation
Log
Current Version: 11.5.0
Chilkat.Log
Use
Add informational messages, error messages, and tagged text values to
explain what the application is doing.
Log integers, 64-bit integers, timestamps, and date/time values when
tracing state changes or timing-sensitive workflows.
Record binary data as Base64, hex, or shortened previews so byte-level
values can be inspected safely in text logs.
Compute and log hashes of data when comparing content, verifying
transformations, or avoiding full data dumps.
Clear the log and continue building new diagnostic output during
repeated operations or test runs.
For an extended overview, see
Log Class Overview.
Build readable structured diagnostic logs with nested context and tagged values.
Chilkat.Log is a lightweight structured logging helper for
creating readable diagnostic logs from application code. It can record nested
operation contexts, informational messages, error messages, timestamps,
integers, 64-bit integers, tagged values, binary data, Base64 data, hex data,
shortened data previews, and computed hashes. It is useful when code needs a
clear step-by-step record of operations, inputs, outputs, and diagnostic
values for troubleshooting.
Nested operation context
EnterContext and LeaveContext to group log
entries under readable operation names.
Messages and errors
Numbers and timestamps
Binary diagnostics
Hash logging
Clear and reuse
Log object, enter a named context for the operation,
log the important values and decisions as the code runs, leave the context,
and inspect the resulting text if troubleshooting is needed. Use
Chilkat.Log for application-level diagnostic output; use
LastErrorText on Chilkat objects for detailed diagnostics from
Chilkat method calls.
Object Creation
# 'this' is not a keyword in Tcl. It can freely be used as a variable name. set this [new CkLog]
Properties
DebugLogFilePath
# ckStr is a CkString
CkLog_get_DebugLogFilePath $this $ckStr
set strVal [CkLog_get_debugLogFilePath $this]
CkLog_put_DebugLogFilePath $this $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.
LastErrorHtml
# ckStr is a CkString
CkLog_get_LastErrorHtml $this $ckStr
set strVal [CkLog_get_lastErrorHtml $this]
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.
topLastErrorText
# ckStr is a CkString
CkLog_get_LastErrorText $this $ckStr
set strVal [CkLog_get_lastErrorText $this]
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.
LastErrorXml
# ckStr is a CkString
CkLog_get_LastErrorXml $this $ckStr
set strVal [CkLog_get_lastErrorXml $this]
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.
topLastMethodSuccess
set boolVal [CkLog_get_LastMethodSuccess $this]
CkLog_put_LastMethodSuccess $this $boolVal
Indicates the success or failure of the most recent method call: 1 means success, 0 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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
Utf8
set boolVal [CkLog_get_Utf8 $this]
CkLog_put_Utf8 $this $boolVal
When set to 1, all string arguments and return values are interpreted as UTF-8 strings. When set to 0, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is 1. Before v11.0.0, it was 0.
VerboseLogging
set boolVal [CkLog_get_VerboseLogging $this]
CkLog_put_VerboseLogging $this $boolVal
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.
Version
# ckStr is a CkString
CkLog_get_Version $this $ckStr
set strVal [CkLog_get_version $this]
Methods
Clear
CkLog_Clear $this $initialTag
Clears all existing log entries and starts a new log whose top-level context is named initialTag.
Log* methods. The completed structured log can be inspected through the Log object's diagnostic text, such as LastErrorText.EnterContext
CkLog_EnterContext $this $tag
Begins a nested logging context named tag. Entries written after this call are grouped inside the new context until a matching LeaveContext is called.
EnterContext with LeaveContext. Contexts may be nested to reflect operation hierarchy.LeaveContext
Ends the current nested logging context and returns logging to its parent context.
LogData
# message is a string
CkLog_LogData $this $tag $message
Adds a tagged text value to the current context. The output associates tag with message, making this useful for named values such as filenames, paths, IDs, states, or protocol fields.
LogDataMax
# message is a string
# maxNumChars is an integer
CkLog_LogDataMax $this $tag $message $maxNumChars
Adds a tagged text value to the current context, but limits the logged value to at most the first maxNumChars characters of message.
LogDateTime
# gmt is a boolean
CkLog_LogDateTime $this $tag $gmt
Logs the current date and time under tag using an RFC 822-style date/time representation. If gmt is 1, the logged time is GMT/UTC; otherwise local system time is used.
LogDateTime for a calendar date with timezone context. Use LogTimestamp for a time-of-day marker.LogError
CkLog_LogError $this $message
Adds message as an error entry in the current logging context.
LastErrorText produced by other Chilkat objects when their operations fail.LogInfo
CkLog_LogInfo $this $message
Adds message as an informational entry in the current logging context.
LogData when the entry is better represented as a named value.LogInt
# value is an integer
CkLog_LogInt $this $tag $value
Adds the integer value to the current log under tag.
LogInt64
# value is a 64-bit integer
CkLog_LogInt64 $this $tag $value
Adds the signed 64-bit integer value to the current log under tag.
LogTimestamp
CkLog_LogTimestamp $this $tag
Logs the current time-of-day under tag in HH:MM:SS:mmm form, where mmm represents milliseconds.
Deprecated
LogDataBase64 Deprecated
# data is a CkByteData
CkLog_LogDataBase64 $this $tag $data
Encodes the supplied binary data as Base64 and adds the encoded value to the current log under tag.
LogDataHex Deprecated
# data is a CkByteData
CkLog_LogDataHex $this $tag $data
Encodes the supplied binary data as hexadecimal text and adds the encoded value to the current log under tag.