Log Class

.NET Framework (current version)

Other Versions

Provides a property and methods for writing event and exception information to the application's log listeners.

Namespace: Microsoft.VisualBasic.Logging
Assembly: Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

Inheritance Hierarchy

System::Object
Microsoft.VisualBasic.Logging::Log
Microsoft.VisualBasic.Logging::AspLog

Syntax

C++

[HostProtectionAttribute(SecurityAction::LinkDemand, Resources = HostProtectionResource::ExternalProcessMgmt)]
public ref class Log

Constructors

	Name	Description
	Log()	Initializes a new instance of the Log class.
	Log(String^)	Initializes a new instance of the Log class.

Properties

	Name	Description
	DefaultFileLogWriter	Gets the file the FileLogTraceListener object that underlies the Log object.
	TraceSource	Gets to the TraceSource object that underlies the Log object.

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	InitializeWithDefaultsSinceNoConfigExists()	Creates a new FileLogTraceListener object and adds it to the Listeners collection.
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)
	WriteEntry(String^)	Writes a message to the application's log listeners.
	WriteEntry(String^, TraceEventType)	Writes a message to the application's log listeners.
	WriteEntry(String^, TraceEventType, Int32)	Writes a message to the application's log listeners.
	WriteException(Exception^)	Writes exception information to the application's log listeners.
	WriteException(Exception^, TraceEventType, String^)	Writes exception information to the application's log listeners.
	WriteException(Exception^, TraceEventType, String^, Int32)	Writes exception information to the application's log listeners.

The My.Application.Log object provides a straightforward entry point from which to access the .NET Framework's logging services. The WriteEntry and WriteException methods write messages to the application's log listeners. The listeners can be configured by the application's configuration file. For more information, see Walkthrough: Changing Where My.Application.Log Writes Information (Visual Basic) and Working with Application Logs in Visual Basic.

The My.Application.Log object is available only for client applications. For Web applications, use My.Log. For more information, see AspLog.

The following table lists examples of tasks involving the My.Application.Log object.

To	See
Write event information to the application's log listeners	How to: Write Log Messages (Visual Basic)
Write exception information to the application's log listeners	How to: Log Exceptions in Visual Basic
Determine where My.Application.Log writes information	Walkthrough: Determining Where My.Application.Log Writes Information (Visual Basic)

Examples

This example shows how to use the My.Application.Log.WriteEntry method to log tracing information. For more information, see How to: Write Log Messages (Visual Basic).

Public Sub TracingTest(ByVal fileName As String)
    My.Application.Log.WriteEntry( 
        "Entering TracingTest with argument " & 
        fileName & ".")
    ' Code to trace goes here.
    My.Application.Log.WriteEntry( 
        "Exiting TracingTest with argument " & 
        fileName & ".")
End Sub

Version Information

.NET Framework
Available since 2.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.