EventLog.EnableRaisingEvents Property

Definition

Namespace:

System.Diagnostics

Assembly:

System.Diagnostics.EventLog.dll

Source:

EventLog.cs

Gets or sets a value indicating whether the EventLog receives EntryWritten event notifications.

C#

[System.ComponentModel.Browsable(false)]
public bool EnableRaisingEvents { get; set; }

Property Value

Boolean

true if the EventLog receives notification when an entry is written to the log; otherwise, false.

Attributes

BrowsableAttribute

Exceptions

InvalidOperationException

The event log is on a remote computer.

Examples

The following example handles an EntryWritten event.

C#

using System;
using System.Diagnostics;
using System.Threading;

class MySample{

    public static void Main(){

        EventLog myNewLog = new EventLog();
        myNewLog.Log = "MyCustomLog";

        myNewLog.EntryWritten += new EntryWrittenEventHandler(MyOnEntryWritten);
        myNewLog.EnableRaisingEvents = true;

        Console.WriteLine("Press \'q\' to quit.");
        // Wait for the EntryWrittenEvent or a quit command.
        while(Console.Read() != 'q'){
            // Wait.
        }
    }

    public static void MyOnEntryWritten(Object source, EntryWrittenEventArgs e){
        Console.WriteLine("Written: " + e.Entry.Message);
    }
}

Remarks

The EnableRaisingEvents property determines whether the EventLog raises events when entries are written to the log. When the property is true, components that receive the EntryWritten event will receive notification any time an entry is written to the log that is specified in the Log property. If EnableRaisingEvents is false, no events are raised.

Note

You can receive event notifications only when entries are written on the local computer. You cannot receive notifications for entries written on remote computers.

Applies to

See also

• EntryWritten