Log ActiveX Reference Documentation

Log

Current Version: 11.5.0

Chilkat.Log

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

Use EnterContext and LeaveContext to group log entries under readable operation names.

Messages and errors

Add informational messages, error messages, and tagged text values to explain what the application is doing.

Numbers and timestamps

Log integers, 64-bit integers, timestamps, and date/time values when tracing state changes or timing-sensitive workflows.

Binary diagnostics

Record binary data as Base64, hex, or shortened previews so byte-level values can be inspected safely in text logs.

Hash logging

Compute and log hashes of data when comparing content, verifying transformations, or avoiding full data dumps.

Clear and reuse

Clear the log and continue building new diagnostic output during repeated operations or test runs.

Common pattern: Create a 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.

For an extended overview, see Log Class Overview.

Object Creation

Note:
For a specific major version, use "Chilkat.Log.<major_version>", such as "Chilkat.Log.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

(ASP)
set obj = Server.CreateObject("Chilkat.Log")

(AutoIt)
$obj = ObjCreate("Chilkat.Log")

(Visual Basic 6.0)
Dim obj As New ChilkatLog

(VBScript)
set obj = CreateObject("Chilkat.Log")

(VBA, such as Excel)
Dim obj As New ChilkatLog
See How to Use ActiveX in Excel

(Delphi)
obj := TChilkatLog.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat.Log')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat.Log")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.Log', @obj OUT

(Javascript)
var obj = new ActiveXObject("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
(AutoIt) Example showing how to use DebugLogFilePath.(Classic ASP) Example showing how to use DebugLogFilePath.(PowerBuilder) Example showing how to use DebugLogFilePath.(SQL Server) Example showing how to use DebugLogFilePath.(VBScript) Example showing how to use DebugLogFilePath.(Visual Basic 6.0) Example showing how to use DebugLogFilePath.(Visual FoxPro) Example showing how to use DebugLogFilePath.
top
LastBinaryResult
LastBinaryResult As Variant (read-only)

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.

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.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
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 Long

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.

top
LastStringResult
LastStringResult As String (read-only)

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.

More Information and Examples
Long Strings Returned by ActiveX Methods in SQL Server
top
LastStringResultLen
LastStringResultLen As Long (read-only)

The length, in characters, of the string contained in the LastStringResult property.

top
VerboseLogging
VerboseLogging As Long

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

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

More Information and Examples
(AutoIt) How to get the Chilkat version at runtime.(Classic ASP) How to get the Chilkat version at runtime.(PowerBuilder) How to get the Chilkat version at runtime.(SQL Server) How to get the Chilkat version at runtime.(VBScript) How to get the Chilkat version at runtime.(Visual Basic 6.0) How to get the Chilkat version at runtime.(Visual FoxPro) How to get the Chilkat version at runtime.
top

Methods

Clear
Clear(initialTag As String)
Introduced in version 9.5.0.44

Clears all existing log entries and starts a new log whose top-level context is named initialTag.

Typical use: Call this at the beginning of an operation or test run, then add entries with the other Log* methods. The completed structured log can be inspected through the Log object's diagnostic text, such as LastErrorText.
top
EnterContext
EnterContext(tag As String)
Introduced in version 9.5.0.44

Begins a nested logging context named tag. Entries written after this call are grouped inside the new context until a matching LeaveContext is called.

Balanced contexts: Pair each EnterContext with LeaveContext. Contexts may be nested to reflect operation hierarchy.
More Information and Examples
(AutoIt) Enter/Leave Context in Logging(Classic ASP) Enter/Leave Context in Logging(PowerBuilder) Enter/Leave Context in Logging(SQL Server) Enter/Leave Context in Logging(VBScript) Enter/Leave Context in Logging(Visual Basic 6.0) Enter/Leave Context in Logging(Visual FoxPro) Enter/Leave Context in Logging
top
LeaveContext
LeaveContext()
Introduced in version 9.5.0.44

Ends the current nested logging context and returns logging to its parent context.

Empty contexts are omitted: If nothing was logged after entering the current context, Chilkat automatically removes that empty context when it is left.
top
LogData
LogData(tag As String, message As String)
Introduced in version 9.5.0.44

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.

Sensitive data: Avoid logging passwords, private keys, access tokens, session secrets, or other sensitive values unless disclosure is intentional.
top
LogDataBase64
LogDataBase64(tag As String, data As Variant)
Introduced in version 9.5.0.44

Encodes the supplied binary data as Base64 and adds the encoded value to the current log under tag.

Base64: Base64 makes arbitrary bytes printable in a text log. It is an encoding, not encryption.
top
LogDataHex
LogDataHex(tag As String, data As Variant)
Introduced in version 9.5.0.44

Encodes the supplied binary data as hexadecimal text and adds the encoded value to the current log under tag.

Hex output: Hex is convenient for short protocol fields, identifiers, digests, and byte-level troubleshooting because each byte is represented by two hex digits.
top
LogDataMax
LogDataMax(tag As String, message As String, ByVal maxNumChars As Long)
Introduced in version 9.5.0.44

Adds a tagged text value to the current context, but limits the logged value to at most the first maxNumChars characters of message.

Diagnostic previews: Use this when a value may be very large and only a leading preview is needed. The original input string is not modified.
top
LogDateTime
LogDateTime(tag As String, ByVal gmt As Long)
Introduced in version 9.5.0.44

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.

Date/time vs. timestamp: Use LogDateTime for a calendar date with timezone context. Use LogTimestamp for a time-of-day marker.
top
LogError
LogError(message As String)
Introduced in version 9.5.0.44

Adds message as an error entry in the current logging context.

Application diagnostics: This is application-defined logging. It is separate from LastErrorText produced by other Chilkat objects when their operations fail.
top
LogInfo
LogInfo(message As String)
Introduced in version 9.5.0.44

Adds message as an informational entry in the current logging context.

Structured tracing: Use informational entries for significant steps and decisions. Use LogData when the entry is better represented as a named value.
top
LogInt
LogInt(tag As String, ByVal value As Long)
Introduced in version 9.5.0.44

Adds the integer value to the current log under tag.

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

Logs the current time-of-day under tag in HH:MM:SS:mmm form, where mmm represents milliseconds.

Timing note: This is a time-of-day marker, not a monotonic elapsed-time measurement.
top