DictionaryBase.ICollection.SyncRoot 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 an object that can be used to synchronize access to a DictionaryBase object.
property System::Object ^ System::Collections::ICollection::SyncRoot { System::Object ^ get(); };object System.Collections.ICollection.SyncRoot { get; }member this.System.Collections.ICollection.SyncRoot : obj ReadOnly Property SyncRoot As Object Implements ICollection.SyncRootProperty Value
An object that can be used to synchronize access to the DictionaryBase object.
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
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.
