Export (0) Print
Expand All

Array.SyncRoot Property

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

Namespace: System
Assembly: mscorlib (in mscorlib.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 Array.

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 Server 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 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

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2014 Microsoft