Log C++ Reference Documentation

CkLog

Current Version: 10.1.2

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

Object Creation

// Local variable on the stack
CkLog obj;

// Dynamically allocate/delete
CkLog *pObj = new CkLog();
// ...
delete pObj;

Properties

DebugLogFilePath

void get_DebugLogFilePath(CkString &str);
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *ansiOrUtf8Str);

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

Example showing how to use DebugLogFilePath.

LastErrorHtml

void get_LastErrorHtml(CkString &str);
const char *lastErrorHtml(void);

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

void get_LastErrorText(CkString &str);
const char *lastErrorText(void);

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

void get_LastErrorXml(CkString &str);
const char *lastErrorXml(void);

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

bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

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.

Utf8

bool get_Utf8(void);
void put_Utf8(bool newVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

VerboseLogging

bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);

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

void get_Version(CkString &str);
const char *version(void);

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

Clear

void Clear(const char *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

void EnterContext(const char *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

Enter/Leave Context in Logging

LeaveContext

void LeaveContext(void);

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

void LogData(const char *tag, const char *message);

Introduced in version 9.5.0.44

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

LogDataBase64

void LogDataBase64(const char *tag, CkByteData &data);

Introduced in version 9.5.0.44

Logs binary data in base64 format.

LogDataBase64_2

void LogDataBase64_2(const char *tag, const void *pByteData, unsigned long szByteData);

Introduced in version 9.5.0.82

Logs binary data in base64 format.

LogDataHex

void LogDataHex(const char *tag, CkByteData &data);

Introduced in version 9.5.0.44

Logs binary data in hex format.

LogDataHex2

void LogDataHex2(const char *tag, const void *pByteData, unsigned long szByteData);

Introduced in version 9.5.0.82

Logs binary data in hex format.

LogDataMax

void LogDataMax(const char *tag, const char *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

void LogDateTime(const char *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

void LogError(const char *message);

Introduced in version 9.5.0.44

Logs an error within the current context.

LogHash2

void LogHash2(const char *tag, const char *hashAlg, const void *pByteData, unsigned long szByteData);

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

void LogInfo(const char *message);

Introduced in version 9.5.0.44

Logs an informational message within the current context.

LogInt

void LogInt(const char *tag, int value);

Introduced in version 9.5.0.44

Logs an integer.

LogInt64

void LogInt64(const char *tag, __int64 value);

Introduced in version 9.5.0.44

Logs a 64-bit integer.

LogTimestamp

void LogTimestamp(const char *tag);

Introduced in version 9.5.0.44

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