Collection.ICollection.SyncRoot Property

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets an object that can be used to synchronize access to the Collection object. Implements the ICollection interface.

Namespace:  Microsoft.VisualBasic
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

Syntax

'Declaration
Private ReadOnly Property ICollectionSyncRoot As Object
    Implements ICollection.SyncRoot
Object ICollection.SyncRoot { get; }

Property Value

Type: System.Object
An object that can be used to synchronize access to the Collection object.

Implements

ICollection.SyncRoot

Remarks

For collections whose underlying store is not publicly available, the expected implementation is to return the current instance. Note that the pointer to the current instance might not be sufficient for collections that wrap other collections; those should return the underlying collection's SyncRoot property.

Most collection classes in the System.Collections namespace also implement a Synchronized method, which provides a synchronized wrapper around the underlying collection. However, derived classes can provide their own synchronized version of the collection using the SyncRoot property. The synchronizing code must perform operations on the SyncRoot property of the collection, not directly on the collection. This guarantees the correct operation of collections that are derived from other objects. Specifically, it maintains the correct synchronization with other threads that might be simultaneously modifying the collection instance.

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.