StringCollection.IsSynchronized Property

Definition

Namespace:

System.Collections.Specialized

Assembly:

System.Collections.Specialized.dll

Source:

StringCollection.cs

Gets a value indicating whether access to the StringCollection is synchronized (thread safe).

public:
 property bool IsSynchronized { bool get(); };

public bool IsSynchronized { get; }

member this.IsSynchronized : bool

Public ReadOnly Property IsSynchronized As Boolean

Property Value

Boolean

This property always returns false.

Implements

IsSynchronized

Remarks

StringCollection implements the IsSynchronized property because it is required by the ICollection interface.

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:

StringCollection^ myCollection = gcnew StringCollection();
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);
    }
}

StringCollection myCollection = new StringCollection();
lock(myCollection.SyncRoot)
{
    foreach (object item in myCollection)
    {
        // Insert your code here.
    }
}

Dim myCollection As New StringCollection()
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