Export (0) Print
Expand All

DictionaryBase.ICollection.SyncRoot Property

Gets an object that can be used to synchronize access to a DictionaryBase object.

Namespace:  System.Collections
Assembly:  mscorlib (in mscorlib.dll)

Object ICollection.SyncRoot { get; }

Property Value

Type: System.Object
An object that can be used to synchronize access to the DictionaryBase object.

Implements

ICollection.SyncRoot

Derived classes can provide their own synchronized version of the DictionaryBase class using the SyncRoot property. The synchronizing code must perform operations on the SyncRoot property of the DictionaryBase object, not directly on the DictionaryBase object. 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 DictionaryBase object.

Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can 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.

The following code example shows how to lock the collection using the SyncRoot property during the entire enumeration.

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

Retrieving the value of this property is an O(1) operation.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1

Community Additions

ADD
Show:
© 2014 Microsoft