XLL+ Class Library (6.3)

cpplog.h

Overview

cpplog.h contains all the core classes and macro definitions for a simple logging mechanism based on the Apache log4j and log4cxx frameworks.

For an introduction to the design and use of the framework, see Logging in the User Guide.

Classes

The table below lists the C++ object classes declared in the header file.

Class Description
Logger A log reporting node, which passes log reports up a tree, and delivers them to log appenders.
LoggerPtr A shared pointer to a logger.
Appender The abstract base class from which all appenders are descended.
FileAppender An appender which writes to a file.
ConsoleAppender An appender which writes to the console.
TraceAppender An appender class which writes to the TRACE macro.
AtlTraceAppender An appender class which writes to the ATLTRACE2 macro.
BasicConfigurator Configures the logging framework to write errors to the console.
PropertyConfigurator Configures the logging framework by reading a text file.
ModulePropertyConfigurator Configures the logging framework by reading a text file, whose name and location is relative to the currently executing module.
XllConfigurator Configures the logging framework for an XLL add-in, by reading a text file, whose name and location is relative to the currently executing module.

Macros

The table below lists the principal macros declared in the header file, in descending order of severity.

Name Description
LOG_FATAL Write a fatal error report to log.
LOG_ERROR Write a non-fatal error report to log.
LOG_WARN Write a warning to log.
LOG_INFO Write an information report to log.
LOG_DEBUG Write a debugging report to log.
LOG_TRACE Write a very low-level report to log.

Enumerations

The table below lists the enumerations declared in the header file.

Enumeration Description
LogLevel Severity levels of log events.