Array.SyncRoot Property

public Object SyncRoot { get; }

/** @property */
public final Object get_SyncRoot ()

public final function get SyncRoot () : Object

Property Value

This property implements the System.Collections.ICollection interface.

.NET Framework classes based on Array provide their own synchronized version of the collection using the SyncRoot property.

Classes that use arrays can also implement their own synchronization using the SyncRoot property. The synchronizing code must perform operations on the SyncRoot of the collection, not directly on the collection. 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 collection. Note that some implementations of SyncRoot might return the Array itself.

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.

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

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

Array myArray = new int[] { 1, 2, 4 };
lock(myArray.SyncRoot) 
{
    foreach (Object item in myArray)
        Console.WriteLine(item);
}

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

.NET Compact Framework