Log Delphi DLL 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.

Create/Dispose

var
myObject: HCkLog;

begin
myObject := CkLog_Create();

// ...

CkLog_Dispose(myObject);
end;

function CkLog_Create: HCkLog; stdcall;

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.

procedure CkLog_Dispose(handle: HCkLog); stdcall;

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_getDebugLogFilePath(objHandle: HCkLog; outPropVal: HCkString); stdcall;
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.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

procedure CkLog_getLastErrorHtml(objHandle: HCkLog; outPropVal: HCkString); stdcall;
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.

LastErrorText

procedure CkLog_getLastErrorText(objHandle: HCkLog; outPropVal: HCkString); stdcall;
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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkLog_getLastErrorXml(objHandle: HCkLog; outPropVal: HCkString); stdcall;
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.

LastMethodSuccess

function CkLog_getLastMethodSuccess(objHandle: HCkLog): wordbool; stdcall;
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.

VerboseLogging

function CkLog_getVerboseLogging(objHandle: HCkLog): wordbool; stdcall;
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

procedure CkLog_getVersion(objHandle: HCkLog; outPropVal: HCkString); stdcall;
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.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

Clear

procedure CkLog_Clear(objHandle: HCkLog;
initialTag: PWideChar) stdcall;

Introduced in version 9.5.0.44

Clears the log. The initialTag is the initial top-level context tag for the new log.

EnterContext

procedure CkLog_EnterContext(objHandle: HCkLog;
tag: PWideChar) stdcall;

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

Enter/Leave Context in Logging

LeaveContext

procedure CkLog_LeaveContext(objHandle: HCkLog) stdcall;

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

procedure CkLog_LogData(objHandle: HCkLog;
tag: PWideChar;
message: PWideChar) stdcall;

Introduced in version 9.5.0.44

Adds a tagged message to the log (i.e. a name/value pair).

LogDataBase64

procedure CkLog_LogDataBase64(objHandle: HCkLog;
tag: PWideChar;
data: HCkByteData) stdcall;

Introduced in version 9.5.0.44

Logs binary data in base64 format.

LogDataBase64_2

procedure CkLog_LogDataBase64_2(objHandle: HCkLog;
    tag: PWideChar;
    pByteData: pbyte;
    szByteData: LongWord) stdcall;

Introduced in version 9.5.0.82

Logs binary data in base64 format.

LogDataHex

procedure CkLog_LogDataHex(objHandle: HCkLog;
tag: PWideChar;
data: HCkByteData) stdcall;

Introduced in version 9.5.0.44

Logs binary data in hex format.

LogDataHex2

procedure CkLog_LogDataHex2(objHandle: HCkLog;
    tag: PWideChar;
    pByteData: pbyte;
    szByteData: LongWord) stdcall;

Introduced in version 9.5.0.82

Logs binary data in hex format.

LogDataMax

procedure CkLog_LogDataMax(objHandle: HCkLog;
    tag: PWideChar;
    message: PWideChar;
    maxNumChars: Integer) stdcall;

Introduced in version 9.5.0.44

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

LogDateTime

procedure CkLog_LogDateTime(objHandle: HCkLog;
tag: PWideChar;
gmt: wordbool) stdcall;

Introduced in version 9.5.0.44

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

procedure CkLog_LogError(objHandle: HCkLog;
message: PWideChar) stdcall;

Introduced in version 9.5.0.44

Logs an error within the current context.

LogHash2

procedure CkLog_LogHash2(objHandle: HCkLog;
    tag: PWideChar;
    hashAlg: PWideChar;
    pByteData: pbyte;
    szByteData: LongWord) stdcall;

Introduced in version 9.5.0.82

Logs the hash of binary data in hex format. The tag can be SHA1, SHA256, SHA384, SHA512, or MD5.

LogInfo

procedure CkLog_LogInfo(objHandle: HCkLog;
message: PWideChar) stdcall;

Introduced in version 9.5.0.44

Logs an informational message within the current context.

LogInt

procedure CkLog_LogInt(objHandle: HCkLog;
tag: PWideChar;
value: Integer) stdcall;

Introduced in version 9.5.0.44

Logs an integer.

LogInt64

procedure CkLog_LogInt64(objHandle: HCkLog;
tag: PWideChar;
value: Int64) stdcall;

Introduced in version 9.5.0.44

Logs a 64-bit integer.

LogTimestamp

procedure CkLog_LogTimestamp(objHandle: HCkLog;
tag: PWideChar) stdcall;

Introduced in version 9.5.0.44

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