Export (0) Print
Expand All

ICollection.IsSynchronized Property

When implemented by a class, gets a value indicating whether access to the ICollection is synchronized (thread-safe).

[Visual Basic]
ReadOnly Property IsSynchronized As Boolean
[C#]
bool IsSynchronized {get;}
[C++]
__property bool get_IsSynchronized();
[JScript]
function get IsSynchronized() : Boolean;

Property Value

true if access to the ICollection is synchronized (thread-safe); otherwise, false.

Remarks

SyncRoot returns an object, which can be used to synchronize access to the ICollection.

Most collection classes in the System.Collections namespace also implement a Synchronized method, which provides a synchronized wrapper around the underlying collection.

Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could 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.

[Visual Basic, C#] The following code example shows how to lock the collection using the SyncRoot during the entire enumeration:

[C#] 
ICollection myCollection = new ICollection();
 lock( myCollection.SyncRoot ) {
 foreach ( Object item in myCollection ) {
 // Insert your code here.
 }
}
[Visual Basic] 
Dim myCollection As New ICollection()
Dim item As Object
SyncLock myCollection.SyncRoot
 For Each item In myCollection
 ' Insert your code here.
 Next item
End SyncLock

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework, Common Language Infrastructure (CLI) Standard

See Also

ICollection Interface | ICollection Members | System.Collections Namespace | SyncRoot

Show:
© 2014 Microsoft