ForEachItem.SyncRoot Property

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime.Enumerators.Item

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Gets an object that can be used to synchronize access to the collection.

public:
 property System::Object ^ SyncRoot { System::Object ^ get(); };

public object SyncRoot { get; }

member this.SyncRoot : obj

Public ReadOnly Property SyncRoot As Object

Property Value

Object

An object that can be used to synchronize access to the collection.

Implements

SyncRoot

Examples

The following code example shows how to lock an ArrayList collection using the SyncRoot during the enumeration.

using System;  
using System.Collections;  

ArrayList myCollection = new ArrayList();  
lock( myCollection.SyncRoot )   
foreach ( Object item in myCollection )   
{  
    // Insert your code here.  
}  

Imports System  
Imports System.Collections  

Dim myCollection As ArrayList =  New ArrayList()   

lock(myCollection.SyncRoot)  
For Each item In myCollection  
    ' Insert your code here.  
Next  

Remarks

Implements ICollection.IsSynchronized. If you are creating a custom collection and deriving from DTSReadOnlyCollectionBase, you can provide your own synchronized version of the collection using the SyncRoot property. The synchronizing code must perform operations on the SyncRoot of the collection, not directly on the collection. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the object.

Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. For more information, see ICollection.IsSynchronized.