SearchResultCollection.ICollection.SyncRoot Propriété

Définition

Obtient un objet qui peut être utilisé pour synchroniser l’accès à ICollection.

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

Valeur de propriété

Objet qui peut être utilisé pour synchroniser l'accès à ICollection.

Implémente

Remarques

Pour les collections dont le magasin sous-jacent n’est pas disponible publiquement, l’implémentation attendue est de retourner l’instance actuelle. Notez que le pointeur vers le instance actuel peut ne pas suffire pour les collections qui encapsulent d’autres collections ; ceux-ci doivent retourner la propriété de SyncRoot la collection sous-jacente.

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. Cependant, les classes dérivées peuvent produire leur propre version synchronisée de la collection à l'aide de la propriété SyncRoot. Le code de synchronisation doit effectuer des opérations sur le SyncRoot de la collection, pas directement sur la collection. Cela garantit un bon fonctionnement des collections dérivées d’autres objets. Plus particulièrement, la synchronisation est assurée avec les autres threads qui pourraient modifier simultanément l'instance de la collection.

En l’absence d’une Synchronized méthode sur une collection, l’utilisation attendue pour SyncRoot ressemble à ceci :

ICollection MyCollection =...  
 lock(MyCollection.SyncRoot) {  
  // Some operation on the collection, which is now thread safe.  
 }  
Dim myCollection as New ICollection()  
 SyncLock myCollection.SyncRoot  
  ' Some operation on the collection, which is now thread safe.  
 End SyncLock  

L’énumération par le biais d’une collection n’est pas intrinsèquement une procédure thread safe. 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. 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.

L’exemple de code suivant montre comment verrouiller la collection à l’aide de pendant SyncRoot toute l’énumération :

ICollection myCollection = new ICollection();  
 lock(myCollection.SyncRoot) {  
  foreach (Object item in myCollection) {  
  // Insert your code here.  
  }  
 }  
Dim myCollection As New ICollection()  
 Dim item As Object  
 SyncLock myCollection.SyncRoot  
  For Each item In myCollection  
  ' Insert your code here.  
  Next item  
 End SyncLock  

S’applique à

Voir aussi