Log Unicode 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

HCkLogW instance = CkLogW_Create();
// ...
CkLogW_Dispose(instance);
HCkLogW CkLogW_Create(void);

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

void CkLogW_Dispose(HCkLogW handle);

Objects created by calling CkLogW_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 CkLogW_Dispose.

Properties

DebugLogFilePath
void CkLogW_getDebugLogFilePath(HCkLogW cHandle, HCkString retval);
void CkLogW_putDebugLogFilePath(HCkLogW cHandle, const wchar_t *newVal);
const wchar_t *CkLogW_debugLogFilePath(HCkLogW 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 CkLogW_getLastErrorHtml(HCkLogW cHandle, HCkString retval);
const wchar_t *CkLogW_lastErrorHtml(HCkLogW 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 CkLogW_getLastErrorText(HCkLogW cHandle, HCkString retval);
const wchar_t *CkLogW_lastErrorText(HCkLogW 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 CkLogW_getLastErrorXml(HCkLogW cHandle, HCkString retval);
const wchar_t *CkLogW_lastErrorXml(HCkLogW 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 CkLogW_getLastMethodSuccess(HCkLogW cHandle);
void CkLogW_putLastMethodSuccess(HCkLogW 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
VerboseLogging
BOOL CkLogW_getVerboseLogging(HCkLogW cHandle);
void CkLogW_putVerboseLogging(HCkLogW 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 CkLogW_getVersion(HCkLogW cHandle, HCkString retval);
const wchar_t *CkLogW_version(HCkLogW cHandle);

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

top

Methods

Clear
void CkLogW_Clear(HCkLogW cHandle, const wchar_t *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 CkLogW_EnterContext(HCkLogW cHandle, const wchar_t *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 CkLogW_LeaveContext(HCkLogW 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 CkLogW_LogData(HCkLogW cHandle, const wchar_t *tag, const wchar_t *message);
Introduced in version 9.5.0.44

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

top
LogDataBase64
void CkLogW_LogDataBase64(HCkLogW cHandle, const wchar_t *tag, const unsigned char * data);
Introduced in version 9.5.0.44

Logs binary data in base64 format.

top
LogDataHex
void CkLogW_LogDataHex(HCkLogW cHandle, const wchar_t *tag, const unsigned char * data);
Introduced in version 9.5.0.44

Logs binary data in hex format.

top
LogDataMax
void CkLogW_LogDataMax(HCkLogW cHandle, const wchar_t *tag, const wchar_t *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 CkLogW_LogDateTime(HCkLogW cHandle, const wchar_t *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 CkLogW_LogError(HCkLogW cHandle, const wchar_t *message);
Introduced in version 9.5.0.44

Logs an error within the current context.

top
LogInfo
void CkLogW_LogInfo(HCkLogW cHandle, const wchar_t *message);
Introduced in version 9.5.0.44

Logs an informational message within the current context.

top
LogInt
void CkLogW_LogInt(HCkLogW cHandle, const wchar_t *tag, int value);
Introduced in version 9.5.0.44

Logs an integer.

top
LogInt64
void CkLogW_LogInt64(HCkLogW cHandle, const wchar_t *tag, __int64 value);
Introduced in version 9.5.0.44

Logs a 64-bit integer.

top
LogTimestamp
void CkLogW_LogTimestamp(HCkLogW cHandle, const wchar_t *tag);
Introduced in version 9.5.0.44

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

top
SaveLastError
BOOL CkLogW_SaveLastError(HCkLogW cHandle, const wchar_t *path);

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

Returns TRUE for success, FALSE for failure.

top