WriteEntry Method (My.Application.Log and My.Log) 

Writes a message to the application's log listeners.

' Usage
My.Application.Log.WriteEntry(message)
My.Application.Log.WriteEntry(message ,severity)
My.Application.Log.WriteEntry(message ,severity ,id)
' Web usage
My.Log.WriteEntry(message)
My.Log.WriteEntry(message ,severity)
My.Log.WriteEntry(message ,severity ,id)
' Declaration
Public Sub WriteEntry( _
   ByVal message As String _
)
' -or-
Public Sub WriteEntry( _
   ByVal message As String, _
   ByVal severity As System.Diagnostics.TraceEventType _
)
' -or-
Public Sub WriteEntry( _
   ByVal message As String, _
   ByVal severity As System.Diagnostics.TraceEventType, _
   ByVal id As Integer _
)

Parameters

• message
  Required. The message to log. If message is Nothing, an empty string is used.

• severity
  The type of message. By default, TraceEventType.Information.

• id
  Message identifier, typically used for correlation. By default, related to entryType as described in the table.

Exceptions

The following conditions cause an exception:

• The exception or message type is Nothing (ArgumentNullException).

• The message type is not one of the TraceEventType enumeration values (InvalidEnumArgumentException).

• Code with partial trust calls the method, but writes to an event log listener that requires full trust (SecurityException).

Remarks

The WriteEntry method writes a message to the application's event log listeners.

In client applications, the Log object is available through the My.Application.Log object. In Web applications, the Log object is available through the My.Log object.

To learn which log listeners receive the WriteEntry method's messages, see Walkthrough: Determining Where My.Application.Log Writes Information. You can change default log listeners. For more information, see Working with Application Logs in Visual Basic.

For overloads that do not take the id argument, the id written to the log is defined by the following table.

Tasks

The following table lists examples of tasks involving the WriteEntry method.

Example

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.

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

This code example can run only within a client application. Change My.Application.Log.WriteEntry to My.Log.WriteEntry for Web applications.

Requirements

Namespace: Microsoft.VisualBasic.Logging

Class: Log

Assembly: Visual Basic Runtime Library (in Microsoft.VisualBasic.dll)

Availability by Project Type

Permissions

The following permission may be necessary:

For more information, see Code Access Security and Requesting Permissions.

See Also

Tasks

How to: Write Log Messages
Walkthrough: Determining Where My.Application.Log Writes Information

Reference

My.Application.Log Object
My.Log Object
System.Diagnostics.TraceEventType
Microsoft.VisualBasic.Logging.Log.WriteEntry(System.String)

Concepts

Working with Application Logs in Visual Basic