NameObjectCollectionBase::KeysCollection::ICollection::SyncRoot Property
Gets an object that can be used to synchronize access to the NameObjectCollectionBase::KeysCollection.
Assembly: System (in System.dll)
private: property Object^ SyncRoot { virtual Object^ get() sealed = ICollection::SyncRoot::get; }
Property Value
Type: System::Object^An object that can be used to synchronize access to the NameObjectCollectionBase::KeysCollection.
Implements
ICollection::SyncRootDerived classes can provide their own synchronized version of the NameObjectCollectionBase::KeysCollection using the SyncRoot property. The synchronizing code must perform operations on the SyncRoot of the NameObjectCollectionBase::KeysCollection, not directly on the NameObjectCollectionBase::KeysCollection. 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 NameObjectCollectionBase::KeysCollection 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.
// Create a collection derived from NameObjectCollectionBase NameObjectCollectionBase^ myBaseCollection = gcnew DerivedCollection(); // Get the ICollection from NameObjectCollectionBase.KeysCollection ICollection^ myKeysCollection = myBaseCollection->Keys; bool lockTaken = false; try { Monitor::Enter(myKeysCollection->SyncRoot, lockTaken); for each (Object^ item in myKeysCollection) { // Insert your code here. } } finally { if (lockTaken) { Monitor::Exit(myKeysCollection->SyncRoot); } }
Retrieving the value of this property is an O(1) operation.
Available since 10
.NET Framework
Available since 2.0