Log C Reference Documentation

Log

Current Version: 9.5.0.73

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

Create/Dispose

HCkLog instance = CkLog_Create();
// ...
CkLog_Dispose(instance);
HCkLog CkLog_Create(void);

Creates an instance of the HCkLog object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkLog_Dispose(HCkLog handle);

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. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkLog_Dispose.

Properties

DebugLogFilePath
void CkLog_getDebugLogFilePath(HCkLog cHandle, HCkString retval);
void CkLog_putDebugLogFilePath(HCkLog cHandle, const char *newVal);
const char *CkLog_debugLogFilePath(HCkLog cHandle);

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.

top
LastErrorHtml
void CkLog_getLastErrorHtml(HCkLog cHandle, HCkString retval);
const char *CkLog_lastErrorHtml(HCkLog cHandle);

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.

top
LastErrorText
void CkLog_getLastErrorText(HCkLog cHandle, HCkString retval);
const char *CkLog_lastErrorText(HCkLog cHandle);

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.

top
LastErrorXml
void CkLog_getLastErrorXml(HCkLog cHandle, HCkString retval);
const char *CkLog_lastErrorXml(HCkLog cHandle);

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.

top
LastMethodSuccess
BOOL CkLog_getLastMethodSuccess(HCkLog cHandle);
void CkLog_putLastMethodSuccess(HCkLog cHandle, BOOL newVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE 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 = TRUE and failure = FALSE.
  • 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 TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Utf8
BOOL CkLog_getUtf8(HCkLog cHandle);
void CkLog_putUtf8(HCkLog cHandle, 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.

top
VerboseLogging
BOOL CkLog_getVerboseLogging(HCkLog cHandle);
void CkLog_putVerboseLogging(HCkLog cHandle, 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.

top
Version
void CkLog_getVersion(HCkLog cHandle, HCkString retval);
const char *CkLog_version(HCkLog cHandle);

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

top

Methods

Clear
void CkLog_Clear(HCkLog cHandle, 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.

top
EnterContext
void CkLog_EnterContext(HCkLog cHandle, 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.

top
LeaveContext
void CkLog_LeaveContext(HCkLog cHandle);
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.)

top
LogData
void CkLog_LogData(HCkLog cHandle, 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).

top
LogDataBase64
void CkLog_LogDataBase64(HCkLog cHandle, const char *tag, HCkByteData data);
Introduced in version 9.5.0.44

Logs binary data in base64 format.

top
LogDataHex
void CkLog_LogDataHex(HCkLog cHandle, const char *tag, HCkByteData data);
Introduced in version 9.5.0.44

Logs binary data in hex format.

top
LogDataMax
void CkLog_LogDataMax(HCkLog cHandle, 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.

top
LogDateTime
void CkLog_LogDateTime(HCkLog cHandle, 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.

top
LogError
void CkLog_LogError(HCkLog cHandle, const char *message);
Introduced in version 9.5.0.44

Logs an error within the current context.

top
LogInfo
void CkLog_LogInfo(HCkLog cHandle, const char *message);
Introduced in version 9.5.0.44

Logs an informational message within the current context.

top
LogInt
void CkLog_LogInt(HCkLog cHandle, const char *tag, int value);
Introduced in version 9.5.0.44

Logs an integer.

top
LogInt64
void CkLog_LogInt64(HCkLog cHandle, const char *tag, __int64 value);
Introduced in version 9.5.0.44

Logs a 64-bit integer.

top
LogTimestamp
void CkLog_LogTimestamp(HCkLog cHandle, const char *tag);
Introduced in version 9.5.0.44

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

top
SaveLastError
BOOL CkLog_SaveLastError(HCkLog cHandle, const char *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns TRUE for success, FALSE for failure.

top