Log Delphi ActiveX Reference Documentation
TChilkatLog
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
var obj: TChilkatLog; ... begin obj := TChilkatLog.Create(Self); ... // When finished, free the object instance. obj.Free();
Properties
DebugLogFilePath
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.
LastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
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.
topLastErrorText
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
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
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.
LastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topVerboseLogging
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
Methods
Clear
Clears the log. The initialTag is the initial top-level context tag for the new log.
EnterContext
Enters a new context labelled with the given tag. Must be paired with a matching call to LeaveContext.
LeaveContext
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.)
topLogData
Adds a tagged message to the log (i.e. a name/value pair).
topLogDataBase64
Logs binary data in base64 format.
topLogDataHex
Logs binary data in hex format.
topLogDataMax
Logs a string, but only up to the 1st maxNumChars characters of the string.
LogDateTime
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.
LogError
Logs an error within the current context.
topLogInfo
Logs an informational message within the current context.
topLogInt
Logs an integer.
topLogTimestamp
Logs the current time in HH:MM:SS:mmm format.
top