NameObjectCollectionBase.KeysCollection.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 the NameObjectCollectionBase.KeysCollection is synchronized (thread safe).

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

private abstract IsSynchronized : bool with get
private override IsSynchronized : bool with get

Property Value

Type: System.Boolean

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

Derived 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.

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: