VariablesCollection.SyncRoot Property

Article
12/15/2008

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

Espace de noms: Microsoft.SqlServer.Dts.Tasks.Exec80PackageTask
Assembly: Microsoft.SqlServer.Exec80PackageTask (in microsoft.sqlserver.exec80packagetask.dll)

Syntaxe

'Déclaration
Public Overridable ReadOnly Property SyncRoot As Object

public virtual Object SyncRoot { get; }

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

/** @property */
public Object get_SyncRoot ()

public function get SyncRoot () : Object

Valeur de propriété

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

Notes

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.

Exemple

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

Sécurité des threads

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Plateformes

Plateformes de développement

Pour obtenir la liste des plateformes prises en charge, consultez Configuration matérielle et logicielle requise pour l'installation de SQL Server 2005.

Plateformes cibles