Log ActiveX 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

Note:
For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.Log" instead of "Chilkat.Log"
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")

(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.

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.

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.

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 LastErrorText LastErrorText Standard Information

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.

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.

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

LastStringResultLen

LastStringResultLen As Long (read-only)

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

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.

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.

Methods

Clear

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.

EnterContext

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

(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

LeaveContext

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.)

LogData

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).

LogDataBase64

LogDataBase64(tag As String, data As Variant)

Introduced in version 9.5.0.44

Logs binary data in base64 format.

LogDataHex

LogDataHex(tag As String, data As Variant)

Introduced in version 9.5.0.44

Logs binary data in hex format.

LogDataMax

LogDataMax(tag As String, message As String, ByVal maxNumChars As Long)

Introduced in version 9.5.0.44

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

LogDateTime

LogDateTime(tag As String, ByVal gmt As Long)

Introduced in version 9.5.0.44

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

LogError(message As String)

Introduced in version 9.5.0.44

Logs an error within the current context.

LogInfo

LogInfo(message As String)

Introduced in version 9.5.0.44

Logs an informational message within the current context.

LogInt

LogInt(tag As String, ByVal value As Long)

Introduced in version 9.5.0.44

Logs an integer.

LogTimestamp

LogTimestamp(tag As String)

Introduced in version 9.5.0.44

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