LogParams Class

class LogParams : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:: SystemIDisposable

Detailed Description

Defines the parameters for writing error messages to a log file.

The messages include the date and time, the source of the error, and the error type: debug, info, warning, error, or fatal. This class also defines the log file name and path.

Referenced by

Library

Uses types

LogOutputFlags

Constructor & Destructor Documentation

LogParams()

LogParams constructor which allows to create LogParams instance.

The LogParams object contains all settings required for logging. The log output, log file name and log string format can be configured with it.

Property Documentation

string LogFileName[get, set]

Gets the path to the file to write the log to.

string LogFormat[get, set]

Gets log format string. The string which allows to write the log in a custom format.

NOTE: PDFL supports the following markers to form output string:

"%d" - current date (mmddyyyy). Example: 07292013 "%t" - current time (hhmmss). Example: 121311 "%s" - error source. Example: "DLFramework" "%e" - error type. It can be debug, info, warning, error, fatal. The value which will be output within this marker depends on severity value. It always outputs "error" string.

"%m" - error message. Example: "Exception: InExistent.pdf: This file cannot be found. Error number: 1074397201" "%T" - full date. It contains current date, current time and the timezone (yyyy-mm-ddThh:mm:ss+/-hh:mm). Example: 2013-07-29T12:13:11+03:00

By default "%T | %s | %e | %m" string format is used.

LogOutputFlags LogOutputFlags[get, set]

Gets LogOutputFlags.

Supported types of logging are: console, file and Event Log (for Windows only). The outputs can be mixed by ORing corresponding flags. It is also possible to suppress any logging using LogOutputFlags.None.

Member Function Documentation

void Dispose()

Returns:

void