In The Hand LtdIn The Hand
FileLogTraceListener Class
NamespacesInTheHand.VisualBasic.LoggingFileLogTraceListener
.NET Components for Mobility
Provides a simple listener that directs logging output to file.
Declaration Syntax
C#Visual Basic
public class FileLogTraceListener : TraceListener
Public Class FileLogTraceListener _
	Inherits TraceListener
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
FileLogTraceListener()()()()
Initializes a new instance of the FileLogTraceListener class with the default name.

FileLogTraceListener(String)
Initializes a new instance of the FileLogTraceListener class with the supplied name.

Append
Determines whether to append the output to the current file or write it to a new file.

Attributes
Gets the custom trace listener attributes defined in the application configuration file.
(Inherited from TraceListener.)
AutoFlush
Indicates whether or not the writing to the log file stream flushes the buffer.

BaseFileName
Gets or sets the base name for the log files, which is used to create the full log-file name.

Close()()()() (Overrides TraceListener.Close()()()().)
CreateObjRef(Type)
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
CustomLocation
Gets or sets the log file directory when the Location property is set to Custom.

Delimiter
Gets or sets the delimiter used to delimit fields within a log message.

DiskSpaceExhaustedBehavior
Determines what to do when writing to the log file and there is less free disk space available than specified by the ReserveDiskSpace property.

Dispose(Boolean)
Releases the unmanaged resources used by the FileLogTraceListener and optionally releases the managed resources
(Overrides TraceListener.Dispose(Boolean).)
Dispose()()()()
Releases all resources used by the TraceListener.
(Inherited from TraceListener.)
Encoding
Gets or sets the encoding to use when creating a new log file.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Fail(String)
Emits an error message to the listener you create when you implement the TraceListener class.
(Inherited from TraceListener.)
Fail(String, String)
Emits an error message and a detailed error message to the listener you create when you implement the TraceListener class.
(Inherited from TraceListener.)
Filter
Gets and sets the trace filter for the trace listener.
(Inherited from TraceListener.)
Finalize()()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Flush()()()() (Overrides TraceListener.Flush()()()().)
FullLogFileName
Gets the current full log-file name.

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetLifetimeService()()()()
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
GetSupportedAttributes()()()()
Gets the custom attributes supported by the trace listener.
(Inherited from TraceListener.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
IndentLevel
Gets or sets the indent level.
(Inherited from TraceListener.)
IndentSize
Gets or sets the number of spaces in an indent.
(Inherited from TraceListener.)
InitializeLifetimeService()()()()
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
IsThreadSafe
Gets a value indicating whether the trace listener is thread safe.
(Inherited from TraceListener.)
Location
Gets or sets location for the log files.

LogFileCreationSchedule
Determines which date to include in the names of the log files.

MaxFileSize
Gets or sets the maximum allowed size of the log file, in bytes.

MemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Name
Gets or sets a name for this TraceListener.
(Inherited from TraceListener.)
NeedIndent
Gets or sets a value indicating whether to indent the output.
(Inherited from TraceListener.)
ReserveDiskSpace
Gets or sets the amount of free disk space, in bytes, necessary before messages can be written to the log file.

ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
TraceData(TraceEventCache, String, TraceEventType, Int32, Object)
Writes trace information, a data object and event information to the listener specific output.
(Inherited from TraceListener.)
TraceData(TraceEventCache, String, TraceEventType, Int32, array<Object>[]()[][])
Writes trace information, an array of data objects and event information to the listener specific output.
(Inherited from TraceListener.)
TraceEvent(TraceEventCache, String, TraceEventType, Int32)
Writes trace and event information to the listener specific output.
(Inherited from TraceListener.)
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)
Writes trace information, a message, and event information to the listener specific output.
(Inherited from TraceListener.)
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, array<Object>[]()[][])
Writes trace information, a formatted array of objects and event information to the listener specific output.
(Inherited from TraceListener.)
TraceOutputOptions
Gets or sets the trace output options.
(Inherited from TraceListener.)
TraceTransfer(TraceEventCache, String, Int32, String, Guid)
Writes trace information, a message, a related activity identity and event information to the listener specific output.
(Inherited from TraceListener.)
Write(String)
Writes a verbatim message to disk, without any additional context information.
(Overrides TraceListener.Write(String).)
Write(String, String) (Overrides TraceListener.Write(String, String).)
Write(Object) (Overrides TraceListener.Write(Object).)
Write(Object, String) (Overrides TraceListener.Write(Object, String).)
WriteIndent()()()()
Writes the indent to the listener you create when you implement this class, and resets the NeedIndent property to false.
(Inherited from TraceListener.)
WriteLine(String)
Writes a verbatim message to disk, followed by the current line terminator, without any additional context information.
(Overrides TraceListener.WriteLine(String).)
WriteLine(String, String) (Overrides TraceListener.WriteLine(String, String).)
WriteLine(Object) (Overrides TraceListener.WriteLine(Object).)
WriteLine(Object, String) (Overrides TraceListener.WriteLine(Object, String).)
Remarks
The FileLogTraceListener class provides automated maintenance capabilities to archive log files as needed, on a daily or per-application basis. This automatic archival functionality helps reduce the maintenance responsibilities of developers and administrators. An instance of FileLogTraceListener can be added to the Debug.Listeners or TraceHelper.Listeners collections to redirect output from logging to a text file. Instances of this class can also be added to My.Application.Log in Visual Basic applications.
Inheritance Hierarchy
Object
MarshalByRefObject
 TraceListener
  FileLogTraceListener

Assembly: InTheHand.VisualBasic (Module: InTheHand.VisualBasic) Version: 7.0.0.0