Export (0) Print
Expand All

EventLog.WriteEntry Method (String, EventLogEntryType, Int32)

.NET Framework 1.1

Writes an entry with the given message text and application-defined event identifier to the event log.

[Visual Basic]
Overloads Public Sub WriteEntry( _
   ByVal message As String, _
   ByVal type As EventLogEntryType, _
   ByVal eventID As Integer _
)
[C#]
public void WriteEntry(
 string message,
 EventLogEntryType type,
 int eventID
);
[C++]
public: void WriteEntry(
 String* message,
 EventLogEntryType type,
 int eventID
);
[JScript]
public function WriteEntry(
   message : String,
 type : EventLogEntryType,
 eventID : int
);

Parameters

message
The string to write to the event log.
type
One of the EventLogEntryType values.
eventID
The application-specific identifier for the event.

Exceptions

Exception Type Condition
ArgumentException The Source property of the EventLog has not been set.

-or-

The method attempted to create a new event source, but the computer name is not valid.

-or-

The method attempted to create a new event source, but the source name was not specified.

-or-

The method attempted to create a new event source, but the source already exists on the computer.

-or-

The method attempted to create a new log, but the first eight characters of the log name are not unique on the computer.

-or-

The method attempted to open the event log with read access, but the Log property was not specified.

-or-

The method attempted to open the event log with write access, but the Source property was not specified.

-or-

The message string is too long. The size must be less than 16384 bytes.

-or-

The source is not registered to the given log.

Exception The registry entry for the log could not be opened on a remote computer.
InvalidOperationException The method attempted to open the event log with write access, but you do not have write access to the log.
Win32Exception The method attempted to release the event log's read or write handle but did not do so successfully.

-or-

The method attempted to open the event log with read access but was unable to do so.

-or-

The event could not be reported to the log.

SystemException The event log could not be notified to start checking for events.

Remarks

Use this method to write an entry with an application-defined eventID to the event log. The eventID together with the source uniquely identify an event. Each application can define its own numbered events and the description strings to which they map. Event viewers display these string values in the Event column. They are intended to help the user understand what went wrong and suggest what actions to take.

In addition to the event identifier, you can specify an EventLogEntryType for the event being written to the event log. The type is indicated in the Event Viewer for a log by an icon and text in the Type column. This indicates whether the event type is error, warning, information, success audit, or failure audit.

You must set the Source property on your EventLog component before writing entries to the log. You can call CreateEventSource on a new source to register it before writing to the event log, but this is not necessary. If the source specified in the Source property of this EventLog instance is not registered on the computer your component is writing to, WriteEntry calls CreateEventSource and registers the source.

Note   If you do not specify a MachineName for your EventLog instance before you call CreateEventSource or WriteEntry, the local computer (".") is assumed.

If the system needs to register the Source through a call to WriteEntry and the Log property has not been set on your EventLog instance, it defaults to the Application log.

Note   Many exceptions listed above are generated by errors raised during the process of registering the Source.

WriteEntry lets you specify a string message to write to the log. This method writes the string directly to the log; it does not use a localizable message file.

Note   If you write an entry to a remote computer, the value of the message (the text string) might not be what you expect if the remote computer is not running the .NET Framework.

Example

[Visual Basic] 
Dim myRemoteMachine As String
Dim myLogName as string = "MyLog"
Console.Write("Enter computer on which to create log : ")
myRemoteMachine = Console.ReadLine()

' Check if the source exists.
if not EventLog.SourceExists("MyTestSource") then
   'Create source.
   EventLog.CreateEventSource("MyTestSource", myLogName,myRemoteMachine)
   Console.WriteLine("Creating EventSource")
else
   'Get the EventLog associated if the source exists.
   myLogName = EventLog.LogNameFromSourceName("MyTestSource",myRemoteMachine)
end if

Dim myEventLog1 As New EventLog(myLogName, myRemoteMachine)
myEventLog1.Source = "MyTestSource"
' Write an entry into log.
myEventLog1.WriteEntry("This is for your information", _
                     EventLogEntryType.SuccessAudit, 100)
Console.WriteLine("An EventLog created on computer " + myEventLog1.MachineName)

[C#] 
string myRemoteMachine;
string myLogName = "MyLog";

Console.Write( "Enter computer on which to create log : " );
myRemoteMachine = Console.ReadLine();

// Check if the source exists.
if(!EventLog.SourceExists("MyTestSource"))
{
   //Create source.
   EventLog.CreateEventSource("MyTestSource", myLogName,myRemoteMachine);
   Console.WriteLine("Creating EventSource");
}
else
   // Get the EventLog associated if the source exists.
   myLogName = EventLog.LogNameFromSourceName("MyTestSource",myRemoteMachine);

EventLog myEventLog1 = new EventLog(myLogName,myRemoteMachine);
myEventLog1.Source = "MyTestSource";
// Write an entry into log.
myEventLog1.WriteEntry("This is for your information",
                               EventLogEntryType.SuccessAudit,100);
Console.WriteLine("An EventLog created on computer "+ 
                               myEventLog1.MachineName);

[C++] 
String* myRemoteMachine;
String* myLogName = S"MyLog";

Console::Write(S"Enter computer on which to create log : ");
myRemoteMachine = Console::ReadLine();

// Check if the source exists.
if (!EventLog::SourceExists(S"MyTestSource")) {
    //Create source.
    EventLog::CreateEventSource(S"MyTestSource", myLogName,myRemoteMachine);
    Console::WriteLine(S"Creating EventSource");
} else
    // Get the EventLog associated if the source exists.
    myLogName = EventLog::LogNameFromSourceName(S"MyTestSource",myRemoteMachine);

EventLog* myEventLog1 = new EventLog(myLogName,myRemoteMachine);
myEventLog1->Source = S"MyTestSource";
// Write an entry into log.
myEventLog1->WriteEntry(S"This is for your information",
    EventLogEntryType::SuccessAudit,100);
Console::WriteLine(S"An EventLog created on computer {0}", myEventLog1->MachineName);

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows NT Server 4.0, Windows NT Workstation 4.0, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

EventLog Class | EventLog Members | System.Diagnostics Namespace | EventLog.WriteEntry Overload List | EventLogEntryType | Source | CreateEventSource | DeleteEventSource | SourceExists | Entries

Show:
© 2014 Microsoft