Export (0) Print
Expand All

Log Class

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)

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

The Log type exposes the following members.

  NameDescription
Public methodLog()Initializes a new instance of the Log class.
Public methodLog(String)Initializes a new instance of the Log class.
Top

  NameDescription
Public propertyDefaultFileLogWriterGets the file the FileLogTraceListener object that underlies the Log object.
Public propertyTraceSourceGets to the TraceSource object that underlies the Log object.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitializeWithDefaultsSinceNoConfigExistsCreates a new FileLogTraceListener object and adds it to the Listeners collection.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWriteEntry(String)Writes a message to the application's log listeners.
Public methodWriteEntry(String, TraceEventType)Writes a message to the application's log listeners.
Public methodWriteEntry(String, TraceEventType, Int32)Writes a message to the application's log listeners.
Public methodWriteException(Exception)Writes exception information to the application's log listeners.
Public methodWriteException(Exception, TraceEventType, String)Writes exception information to the application's log listeners.
Public methodWriteException(Exception, TraceEventType, String, Int32)Writes exception information to the application's log listeners.
Top

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)

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Resources. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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