Export (0) Print
Expand All

StringCollection.SyncRoot Property

Gets an object that can be used to synchronize access to the StringCollection.

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

public Object SyncRoot { get; }
/** @property */
public final Object get_SyncRoot ()

public final function get SyncRoot () : Object

Not applicable.

Property Value

An object that can be used to synchronize access to the StringCollection.

Derived classes can provide their own synchronized version of the StringCollection using the SyncRoot property. The synchronizing code must perform operations on the SyncRoot of the StringCollection, not directly on the StringCollection. 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 StringCollection 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:

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

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

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft