NameObjectCollectionBase.ICollection.IsSynchronized Property

Definition

Namespace:

System.Collections.Specialized

Assembly:

System.Collections.Specialized.dll

Source:

NameObjectCollectionBase.cs

Gets a value indicating whether access to the NameObjectCollectionBase 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.IsSynchronized

Property Value

Boolean

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

Implements

IsSynchronized

Remarks

A NameObjectCollectionBase object is not synchronized. Derived classes can provide a synchronized version of the NameObjectCollectionBase 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.

The following code example shows how to lock the collection using the SyncRoot property during the entire enumeration.

// Create a collection derived from NameObjectCollectionBase
ICollection^ myCollection = gcnew DerivedCollection();
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);
    }
}

// Create a collection derived from NameObjectCollectionBase
ICollection myCollection = new DerivedCollection();
lock(myCollection.SyncRoot)
{
    foreach (object item in myCollection)
    {
        // Insert your code here.
    }
}

' Create a collection derived from NameObjectCollectionBase
Dim myCollection As ICollection = New DerivedCollection()
SyncLock myCollection.SyncRoot
    For Each item As Object In myCollection
        ' Insert your code here.
    Next item
End SyncLock

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

See also

• SyncRoot