NameObjectCollectionBase.ICollection.SyncRoot Property

 

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

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

private abstract SyncRoot : Object with get
private override SyncRoot : Object with get

Property Value

Type: System.Object

An object that can be used to synchronize access to the NameObjectCollectionBase object.

Derived classes can provide their own synchronized version of the NameObjectCollectionBase class using the SyncRoot property. The synchronizing code must perform operations on the SyncRoot property of the NameObjectCollectionBase object, not directly on the NameObjectCollectionBase 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 NameObjectCollectionBase 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.

No code example is currently available or this language may not be supported.

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

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