Collection.ICollectionSyncRoot Property

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)

Private ReadOnly Property ICollectionSyncRoot() As Object _
   Implements ICollection.SyncRoot

private object ICollectionSyncRoot { get; }

Return Value

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

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 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 instance.

Version Information

.NET Framework

Supported in: 2.0, 1.1, 1.0

See Also

Reference

Collection.ICollectionIsSynchronized Property
Collection
ICollection
SyncRoot