Επεξεργασία

Κοινή χρήση μέσω

StringCollection.SyncRoot Property

  • Reference

Definition

Namespace:
System.Collections.Specialized
Assemblies:
System.dll, System.Collections.Specialized.dll
Assembly:
System.Collections.Specialized.dll
Assembly:
System.dll
Assembly:
netstandard.dll
Source:
StringCollection.cs
Source:
StringCollection.cs
Source:
StringCollection.cs

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

public:
 property System::Object ^ SyncRoot { System::Object ^ get(); };
public object SyncRoot { get; }
member this.SyncRoot : obj
Public ReadOnly Property SyncRoot As Object

Property Value

Object

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

Implements

SyncRoot

Remarks

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 = gcnew StringCollection();
bool lockTaken = false;
try
{
    Monitor::Enter(myCollection->SyncRoot, lockTaken);
    for each (Object^ item in myCollection)
    {
        // Insert your code here.
    }
}
finally
{
    if (lockTaken)
    {
        Monitor::Exit(myCollection->SyncRoot);
    }
}

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

Dim myCollection As New StringCollection()
SyncLock myCollection.SyncRoot
    For Each item as Object In myCollection
        ' Insert your code here.
    Next item
End SyncLock

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

Applies to

See also