EventLog.SynchronizingObject Property

Definition

Gets or sets the object used to marshal the event handler calls issued as a result of an EventLog entry written event.

public:
 property System::ComponentModel::ISynchronizeInvoke ^ SynchronizingObject { System::ComponentModel::ISynchronizeInvoke ^ get(); void set(System::ComponentModel::ISynchronizeInvoke ^ value); };
[System.ComponentModel.Browsable(false)]
public System.ComponentModel.ISynchronizeInvoke SynchronizingObject { get; set; }
[<System.ComponentModel.Browsable(false)>]
member this.SynchronizingObject : System.ComponentModel.ISynchronizeInvoke with get, set
Public Property SynchronizingObject As ISynchronizeInvoke

Property Value

The ISynchronizeInvoke used to marshal event-handler calls issued as a result of an EntryWritten event on the event log.

Attributes

Remarks

When SynchronizingObject is null, methods handling the EntryWritten event are called on a thread from the system thread pool. For more information on system thread pools, see ThreadPool.

When the EntryWritten event is handled by a visual Windows Forms component, such as a button, accessing the component through the system thread pool might not work, or might result in an exception. Avoid this by setting SynchronizingObject to a Windows Forms component, which causes the methods handling the EntryWritten event to be called on the same thread on which the component was created.

If the EventLog is used inside Visual Studio 2005 in a Windows Forms designer, SynchronizingObject is automatically set to the control containing the EventLog. For example, if you place an EventLog on a designer for Form1 (which inherits from Form) the SynchronizingObject property of EventLog is set to the instance of Form1.

Applies to

See also