DictionaryBase.ICollection.IsSynchronized Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets a value indicating whether access to a DictionaryBase object is synchronized (thread safe).
property bool System::Collections::ICollection::IsSynchronized { bool get(); };bool System.Collections.ICollection.IsSynchronized { get; }member this.System.Collections.ICollection.IsSynchronized : bool ReadOnly Property IsSynchronized As Boolean Implements ICollection.IsSynchronizedProperty Value
true if access to the DictionaryBase object is synchronized (thread safe); otherwise, false. The default is false.
Implements
Examples
The following code example shows how to lock the collection using the SyncRoot property during the entire enumeration.
ICollection^ myCollection = gcnew ShortStringDictionary();
bool lockTaken = false;
try
{
Monitor::Enter(myCollection->SyncRoot, lockTaken);
for each (Object^ item in myCollection);
{
// Insert your code here.
}
}
finally
{
if (lockTaken)
{
Monitor::Exit(myCollection->SyncRoot);
}
}
ICollection myCollection = new ShortStringDictionary();
lock(myCollection.SyncRoot)
{
foreach (Object item in myCollection)
{
// Insert your code here.
}
}
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.
Remarks
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.
