NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

EventLog.WriteEntry (String)

Writes an information type entry with the given message text to the event log.

[Visual Basic]
Overloads Overridable Public Sub WriteEntry( _
   ByVal message As String _
)
[C#]
public virtual void WriteEntry(
   string message
);
[C++]
public: virtual void WriteEntry(
   String* message
);
[JScript]
public function WriteEntry(
   message : String
);

Parameters

message
The string to write to the event log

Exceptions

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

-or-

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

-or-

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

-or-

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

-or-

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

-or-

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

-or-

The method has 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 has 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 failed.

-or-

The method attempted to open the event log with read access but failed.

-or-

The event could not be reported to the log.

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

Remarks

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

Use this overload if you want to write an information entry to the event log. If you want to specify any other EventLogEntryType, use a different overload of WriteEntry.

You must set the Source property on your EventLog component before you can write 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 a new Source has not been registered on the computer to which your component is writing, WriteEntry calls CreateEventSource automatically and registers the Source for you.

If you have not specified a MachineName for your EventLog instance before calling 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 of the exceptions listed above are generated by errors raised during the process of registering the Source.

Example [Visual Basic]

The following example connects to a log with the source "myNewSource". It then writes an entry to the log. This example assumes there is an existing source named "myNewSource" on the local computer.

Import the System.Diagnostics namespace for this example.

[Visual Basic]

Private Sub WriteToEventLog()
    'Declare a new event log and event log entry.
    Dim evtLog As EventLog

    'Instantiate a new event log.
    evtLog = New EventLog

    'Connect the source to the event instance.
    evtLog.Source = "myNewSource"
    
    'Write an entry to the event log.
    evtLog.WriteEntry("Event log entry.")
End Sub

See Also

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