Log ActiveX Reference Documentation

Log

Handy logging class exposing much of the functionality used internally by Chilkat for LastErrorText, LastErrorXml, and LastErrorHtml.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatLog

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

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

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

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

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

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

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.Log");

Properties

DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

LastBinaryResult As Variant (read-only)

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

LastErrorHtml As String (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastErrorText As String (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

LastErrorXml As String (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastMethodSuccess As Long

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

LastStringResult As String (read-only)

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen As Long (read-only)

Introduced in version 9.5.0.53

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

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

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

Methods

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

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(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(tag As String, data As Variant)

Introduced in version 9.5.0.44

Logs binary data in base64 format.

LogDataHex(tag As String, data As Variant)

Introduced in version 9.5.0.44

Logs binary data in hex format.

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(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(message As String)

Introduced in version 9.5.0.44

Logs an error within the current context.

LogInfo(message As String)

Introduced in version 9.5.0.44

Logs an informational message within the current context.

LogInt(tag As String, ByVal value As Long)

Introduced in version 9.5.0.44

Logs an integer.

LogTimestamp(tag As String)

Introduced in version 9.5.0.44

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