Public Member Functions

CFileLogOutputter Class Reference

Write log to file. More...

#include <LogOutputters.h>

Inherits ILogOutputter.

List of all members.

Public Member Functions

 CFileLogOutputter (const char *logFile)
virtual void open (const char *title)
 Open the outputter.
virtual void close ()
 Close the outputter.
virtual void show (bool showIfEmpty)
 Show the outputter.
virtual bool write (ELevel level, const char *message)
 Write a message with level.

Detailed Description

Write log to file.

This outputter writes output to the file. The level for each message is ignored.

Definition at line 73 of file LogOutputters.h.


Member Function Documentation

void CFileLogOutputter::close (  )  [virtual]

Close the outputter.

Close the outputter. Calling this method on an already closed outputter must have no effect.

Implements ILogOutputter.

Definition at line 262 of file LogOutputters.cpp.

void CFileLogOutputter::open ( const char *  title  )  [virtual]

Open the outputter.

Opens the outputter for writing. Calling this method on an already open outputter must have no effect.

Implements ILogOutputter.

Definition at line 259 of file LogOutputters.cpp.

void CFileLogOutputter::show ( bool  showIfEmpty  )  [virtual]

Show the outputter.

Causes the output to become visible. This generally only makes sense for a logger in a graphical user interface. Other implementations will do nothing. Iff showIfEmpty is false then the implementation may optionally only show the log if it's not empty.

Implements ILogOutputter.

Definition at line 265 of file LogOutputters.cpp.

bool CFileLogOutputter::write ( ELevel  level,
const char *  message 
) [virtual]

Write a message with level.

Writes message, which has the given level, to a log. If this method returns true then CLog will stop passing the message to all outputters in the outputter chain, otherwise it continues. Most implementations should return true.

Implements ILogOutputter.

Definition at line 246 of file LogOutputters.cpp.


The documentation for this class was generated from the following files: