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.
Create/Dispose
HCkLog instance = CkLog_Create(); // ... CkLog_Dispose(instance);
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.
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_putDebugLogFilePath(HCkLog cHandle, const char *newVal);
const char *CkLog_debugLogFilePath(HCkLog cHandle);
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.
LastErrorHtml
const char *CkLog_lastErrorHtml(HCkLog cHandle);
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.
topLastErrorText
const char *CkLog_lastErrorText(HCkLog cHandle);
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.
LastErrorXml
const char *CkLog_lastErrorXml(HCkLog cHandle);
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.
topLastMethodSuccess
void CkLog_putLastMethodSuccess(HCkLog cHandle, 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.
topUtf8
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.
topVerboseLogging
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.
topVersion
Methods
Clear
Clears the log. The initialTag is the initial top-level context tag for the new log.
topEnterContext
Enters a new context labelled with the given tag. Must be paired with a matching call to LeaveContext.
LeaveContext
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.)
topLogData
Adds a tagged message to the log (i.e. a name/value pair).
topLogDataBase64
Logs binary data in base64 format.
topLogDataBase64_2
Logs binary data in base64 format.
topLogDataHex
Logs binary data in hex format.
topLogDataHex2
Logs binary data in hex format.
topLogDataMax
Logs a string, but only up to the 1st maxNumChars characters of the string.
topLogDateTime
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.
topLogError
Logs an error within the current context.
topLogHash2
Logs the hash of binary data in hex format. The tag can be SHA1, SHA256, SHA384, SHA512, or MD5.
topLogInfo
Logs an informational message within the current context.
topLogInt
Logs an integer.
topLogInt64
Logs a 64-bit integer.
topLogTimestamp
Logs the current time in HH:MM:SS:mmm format.
top