Sylloge
A C# helper library
Public Member Functions | Properties
Sylloge.Log.File Class Reference

Inherited by Sylloge.Log.Visual.

List of all members.

Public Member Functions

 File ()
 The default constructor.
 File (string logName)
 Creates an instance and opens the log file with the specified file name.
void Close ()
 Closes this instance.
void Dispose ()
 Closes the underlying handles and releases any resources.
virtual void Log (string msg)
 Writes a message to the log file and Console.
bool Open (string logName)
 Opens a log instance with a specified file name appending to the file (if it exists)
bool Open (string logName, bool append)
 Opens a log instance with a specified file name.

Properties

string LogName [get, set]
 Gets the log file name associated with this instance.

Detailed Description

Definition at line 22 of file Log.cs.


Constructor & Destructor Documentation

Sylloge.Log.File.File ( )

The default constructor.

Definition at line 51 of file Log.cs.

Sylloge.Log.File.File ( string  logName)

Creates an instance and opens the log file with the specified file name.

Parameters:
logNameThe log file to use

Definition at line 64 of file Log.cs.


Member Function Documentation

void Sylloge.Log.File.Close ( )

Closes this instance.

Definition at line 84 of file Log.cs.

void Sylloge.Log.File.Dispose ( )

Closes the underlying handles and releases any resources.

Definition at line 98 of file Log.cs.

virtual void Sylloge.Log.File.Log ( string  msg) [virtual]

Writes a message to the log file and Console.

Parameters:
msgThe message to write and display

Reimplemented in Sylloge.Log.Visual.

Definition at line 110 of file Log.cs.

bool Sylloge.Log.File.Open ( string  logName)

Opens a log instance with a specified file name appending to the file (if it exists)

Parameters:
logNameThe log file to open/append
Returns:
True on successful open of the log file

Definition at line 137 of file Log.cs.

bool Sylloge.Log.File.Open ( string  logName,
bool  append 
)

Opens a log instance with a specified file name.

Parameters:
logNameThe log file to open
appendTrue to append to the log file, false to overwrite it
Returns:
True on successful open of the log file

Definition at line 148 of file Log.cs.


Property Documentation

string Sylloge.Log.File.LogName [get, set]

Gets the log file name associated with this instance.

Definition at line 40 of file Log.cs.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties Events