DictionaryBase.ICollection.IsSynchronized 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 a value indicating whether access to a DictionaryBase object is synchronized (thread safe).

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

Private ReadOnly Property IsSynchronized As Boolean Implements ICollection.IsSynchronized

Property Value

Type: System.Boolean

true if access to the DictionaryBase object is synchronized (thread safe); otherwise, false. The default is false.

A DictionaryBase object is not synchronized. Derived classes can provide a synchronized version of the DictionaryBase class using the SyncRoot property.

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.

Dim myCollection As ICollection = New ShortStringDictionary()
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.

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1
Return to top
Show: