Log C# 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

Chilkat.Log obj = new Chilkat.Log();

Properties

DebugLogFilePath

public string DebugLogFilePath {get; set; }

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

(C#) Example showing how to use DebugLogFilePath.(PowerShell) Example showing how to use DebugLogFilePath.

LastErrorHtml

public string LastErrorHtml {get; }

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

public string LastErrorText {get; }

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

public string LastErrorXml {get; }

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

public bool LastMethodSuccess {get; set; }

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

public bool VerboseLogging {get; set; }

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

public string Version {get; }

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

More Information and Examples

(C#) How to get the Chilkat version at runtime.(PowerShell) How to get the Chilkat version at runtime.

Methods

Clear

public void Clear(string initialTag);

Introduced in version 9.5.0.44

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

EnterContext

public void EnterContext(string tag);

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

(C#) Enter/Leave Context in Logging (PowerShell) Enter/Leave Context in Logging

LeaveContext

public void 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

public void LogData(string tag, string message);

Introduced in version 9.5.0.44

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

LogDataBase64

public void LogDataBase64(string tag, byte[] data);

Introduced in version 9.5.0.44

Logs binary data in base64 format.

LogDataHex

public void LogDataHex(string tag, byte[] data);

Introduced in version 9.5.0.44

Logs binary data in hex format.

LogDataMax

public void LogDataMax(string tag, string message, int maxNumChars);

Introduced in version 9.5.0.44

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

LogDateTime

public void LogDateTime(string tag, bool gmt);

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

public void LogError(string message);

Introduced in version 9.5.0.44

Logs an error within the current context.

LogInfo

public void LogInfo(string message);

Introduced in version 9.5.0.44

Logs an informational message within the current context.

LogInt

public void LogInt(string tag, int value);

Introduced in version 9.5.0.44

Logs an integer.

LogInt64

public void LogInt64(string tag, long value);

Introduced in version 9.5.0.44

Logs a 64-bit integer.

LogTimestamp

public void LogTimestamp(string tag);

Introduced in version 9.5.0.44

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