StringCollection.IsSynchronized Property (System.Collections.Specialized)

Switch View :
ScriptFree
.NET Framework Class Library
StringCollection.IsSynchronized Property

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

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

Visual Basic
Public ReadOnly Property IsSynchronized As Boolean
	Get
C#
public bool IsSynchronized { get; }
Visual C++
public:
virtual property bool IsSynchronized {
	bool get () sealed;
}
F#
abstract IsSynchronized : bool
override IsSynchronized : bool

Property Value

Type: System.Boolean
This property always returns false.

Implements

ICollection.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:

Visual Basic

Dim myCollection As New StringCollection()
SyncLock myCollection.SyncRoot
    For Each item as Object In myCollection
        ' Insert your code here.
    Next item
End SyncLock


C#

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


Visual C++

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);
    }
}


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

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
See Also

Reference