ICollection.SyncRoot ICollection.SyncRoot ICollection.SyncRoot ICollection.SyncRoot Property

Définition

Obtient un objet qui peut être utilisé pour synchroniser l'accès à ICollection.Gets an object that can be used to synchronize access to the ICollection.

public:
 property System::Object ^ SyncRoot { System::Object ^ get(); };
public object SyncRoot { get; }
member this.SyncRoot : obj
Public ReadOnly Property SyncRoot As Object

Valeur de propriété

Objet qui peut être utilisé pour synchroniser l'accès à ICollection.An object that can be used to synchronize access to the ICollection.

Remarques

Pour les collections dont le magasin sous-jacent n’est pas disponible publiquement, l’implémentation attendue est de retourner l’instance actuelle.For collections whose underlying store is not publicly available, the expected implementation is to return the current instance. Notez que le pointeur vers l’instance actuelle peut ne pas suffire pour les collections qui renvoient à d’autres collections ; celles-ci doivent retourner la collection sous-jacente SyncRoot propriété.Note that the pointer to the current instance might not be sufficient for collections that wrap other collections; those should return the underlying collection's SyncRoot property.

La plupart des classes de collection dans l'espace de noms System.Collections implémentent également une méthode Synchronized qui fournit un wrapper synchronisé autour de la collection sous-jacente.Most collection classes in the System.Collections namespace also implement a Synchronized method, which provides a synchronized wrapper around the underlying collection. Cependant, les classes dérivées peuvent produire leur propre version synchronisée de la collection à l’aide de la propriété SyncRoot.However, derived classes can provide their own synchronized version of the collection using the SyncRoot property. Le code de synchronisation doit effectuer les opérations sur la propriété SyncRoot de la collection, et non directement sur la collection.The synchronizing code must perform operations on the SyncRoot property of the collection, not directly on the collection. Cela garantit un bon fonctionnement des collections dérivées d’autres objets.This ensures proper operation of collections that are derived from other objects. Plus particulièrement, la synchronisation est assurée avec les autres threads qui pourraient modifier simultanément l'instance de la collection.Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the collection instance.

En l’absence d’un Synchronized méthode sur une collection, l’utilisation attendue pour SyncRoot se présente comme suit :In the absence of a Synchronized method on a collection, the expected usage for SyncRoot looks as follows:

ICollection^ myCollection = someCollection;
bool lockTaken = false;
try
{
    Monitor::Enter(myCollection->SyncRoot, lockTaken);
    // Some operation on the collection, which is now thread safe.
}
finally
{
    if (lockTaken)
    {
        Monitor::Exit(myCollection->SyncRoot);
    }
}
ICollection myCollection = someCollection;
lock(myCollection.SyncRoot)
{
    // Some operation on the collection, which is now thread safe.
}
Dim myCollection As ICollection = someCollection
SyncLock myCollection.SyncRoot
    ' Some operation on the collection, which is now thread safe.
End SyncLock

L'énumération d'une collection n'est intrinsèquement pas une procédure thread-safe.Enumerating through a collection is intrinsically not a thread-safe procedure. Même lorsqu'une collection est synchronisée, les autres threads peuvent toujours la modifier, ce qui entraîne la levée d'une exception par l'énumérateur.Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. Pour garantir la sécurité des threads au cours de l’énumération, vous pouvez verrouiller la collection pendant l’ensemble de l’énumération ou bien intercepter les exceptions résultant des modifications apportées par les autres threads.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.

L’exemple de code suivant montre comment verrouiller la collection en utilisant le SyncRoot propriété pendant toute l’énumération.The following code example shows how to lock the collection using the SyncRoot property during the entire enumeration.

ICollection^ myCollection = someCollection;
bool lockTaken = false;
try
{
    Monitor::Enter(myCollection->SyncRoot, lockTaken);
    for each (Object^ item in myCollection);
    {
        // Insert your code here.
    }
}
finally
{
    if (lockTaken)
    {
        Monitor::Exit(myCollection->SyncRoot);
    }
}
ICollection myCollection = someCollection;
lock(myCollection.SyncRoot)
{
    foreach (object item in myCollection)
    {
        // Insert your code here.
    }
}
Dim myCollection As ICollection = someCollection
SyncLock myCollection.SyncRoot
    For Each item In myCollection
        ' Insert your code here.
    Next item
End SyncLock

S’applique à

Voir aussi