BitArray.SyncRoot Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

public object SyncRoot { get; }

Property Value

Type: System.Object

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

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

BitArray myCollection = new BitArray(64, true);
lock(myCollection.SyncRoot)
{
    foreach (object item in myCollection)
    {
        // Insert your code here.
    }
}

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

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: