ICollection.SyncRoot プロパティ

定義

ICollection へのアクセスを同期するために使用できるオブジェクトを取得します。Gets an object that can be used to synchronize access to the ICollection.

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

プロパティ値

Object

ICollection へのアクセスの同期に使用できるオブジェクトです。An object that can be used to synchronize access to the ICollection.

注釈

基になっているストアがパブリックではないコレクションの場合、現在のインスタンスを返す実装が要求されます。For collections whose underlying store is not publicly available, the expected implementation is to return the current instance. 現在のインスタンスへのポインターは、他のコレクションをラップするコレクションには不十分である可能性があることに注意してください。これらは、基になるコレクションのプロパティを返し SyncRoot ます。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.

System.Collections 名前空間内のほとんどのコレクション クラスは、Synchronized メソッドも実装しています。このメソッドは、基になるコレクションをラップする同期されたラッパーを提供します。Most collection classes in the System.Collections namespace also implement a Synchronized method, which provides a synchronized wrapper around the underlying collection. ただし、派生クラスは SyncRoot プロパティを使って、コレクションの同期されたバージョンを独自に提供できます。However, derived classes can provide their own synchronized version of the collection using the SyncRoot property. 同期されたコードでは、コレクションを直接操作するのではなく、コレクションの SyncRoot プロパティに対して操作を実行します。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.

コレクションに対してメソッドが存在しない Synchronized 場合、の予想される使用法は次のように SyncRoot なります。In the absence of a Synchronized method on a collection, the expected usage for SyncRoot looks as follows:

ICollection^ myCollection = someCollection;
bool lockTaken = false;
try
{
    Monitor::Enter(myCollection->SyncRoot, lockTaken);
    // Some operation on the collection, which is now thread safe.
}
finally
{
    if (lockTaken)
    {
        Monitor::Exit(myCollection->SyncRoot);
    }
}
ICollection myCollection = someCollection;
lock(myCollection.SyncRoot)
{
    // Some operation on the collection, which is now thread safe.
}
Dim myCollection As ICollection = someCollection
SyncLock myCollection.SyncRoot
    ' Some operation on the collection, which is now thread safe.
End SyncLock

コレクションの列挙処理は、本質的にスレッドセーフな処理ではありません。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.

次のコード例は、列挙体全体でプロパティを使用してコレクションをロックする方法を示して SyncRoot います。The following code example shows how to lock the collection using the SyncRoot property during the entire enumeration.

ICollection^ myCollection = someCollection;
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);
    }
}
ICollection myCollection = someCollection;
lock(myCollection.SyncRoot)
{
    foreach (object item in myCollection)
    {
        // Insert your code here.
    }
}
Dim myCollection As ICollection = someCollection
SyncLock myCollection.SyncRoot
    For Each item In myCollection
        ' Insert your code here.
    Next item
End SyncLock

適用対象

こちらもご覧ください