Log Delphi DLL 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.
Create/Dispose
var myObject: HCkLog; begin myObject := CkLog_Create(); // ... CkLog_Dispose(myObject); end;
Creates an instance of the HCkLog object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkLog_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.
Properties
DebugLogFilePath
procedure CkLog_putDebugLogFilePath(objHandle: HCkLog; newPropVal: PWideChar); stdcall;
function CkLog__debugLogFilePath(objHandle: HCkLog): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
LastErrorHtml
function CkLog__lastErrorHtml(objHandle: HCkLog): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLastErrorText
function CkLog__lastErrorText(objHandle: HCkLog): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
LastErrorXml
function CkLog__lastErrorXml(objHandle: HCkLog): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLastMethodSuccess
procedure CkLog_putLastMethodSuccess(objHandle: HCkLog; newPropVal: wordbool); stdcall;
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. 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.
VerboseLogging
procedure CkLog_putVerboseLogging(objHandle: HCkLog; newPropVal: wordbool); stdcall;
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.
Version
function CkLog__version(objHandle: HCkLog): PWideChar; stdcall;
Version of the component/library, such as "10.1.0"
See the notes about PWideChar memory ownership and validity.
Methods
Clear
initialTag: PWideChar) stdcall;
Clears the log. The initialTag is the initial top-level context tag for the new log.
EnterContext
tag: PWideChar) stdcall;
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
tag: PWideChar;
message: PWideChar) stdcall;
Adds a tagged message to the log (i.e. a name/value pair).
topLogDataMax
tag: PWideChar;
message: PWideChar;
maxNumChars: Integer) stdcall;
Logs a string, but only up to the 1st maxNumChars characters of the string.
LogDateTime
tag: PWideChar;
gmt: wordbool) stdcall;
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.
LogError
message: PWideChar) stdcall;
Logs an error within the current context.
topLogInfo
message: PWideChar) stdcall;
Logs an informational message within the current context.
topLogInt
tag: PWideChar;
value: Integer) stdcall;
Logs an integer.
topLogInt64
tag: PWideChar;
value: Int64) stdcall;
Logs a 64-bit integer.
topLogTimestamp
tag: PWideChar) stdcall;
Logs the current time in HH:MM:SS:mmm format.
topDeprecated
LogDataBase64 Deprecated
Logs binary data in base64 format.
topLogDataHex Deprecated
Logs binary data in hex format.
top