BitArray.SyncRoot Property

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

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

Syntax

'Declaration
Public ReadOnly Property SyncRoot As Object
public Object SyncRoot { get; }

Property Value

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

Implements

ICollection.SyncRoot

Remarks

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.

Examples

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

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

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

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.