Array.SyncRoot プロパティ

.NET Framework クラス ライブラリ リファレンス

Array.SyncRoot プロパティ

Array へのアクセスを同期するために使用できるオブジェクトを取得します。

名前空間: System
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public ReadOnly Property
 SyncRoot As Object

Visual Basic (使用法)

Dim instance As Array
Dim value As Object

value = instance.SyncRoot

C#

public Object SyncRoot { get; }

C++

public:
virtual property Object^ SyncRoot {
    Object^ get () sealed;
}

J#

/** @property */
public final Object get_SyncRoot ()

JScript

public final function get
 SyncRoot () : Object

プロパティ値
Array へのアクセスを同期するために使用できるオブジェクト。

解説

このプロパティは、System.Collections.ICollection インターフェイスを実装します。

Array を基本クラスとする .NET Framework クラスでは、SyncRoot プロパティによって、コレクションの独自の同期されたバージョンが用意されています。

配列を使用するクラスでは、SyncRoot プロパティを使用して、独自の同期を実装することもできます。コードによる同期操作は、コレクションで直接実行するのではなく、コレクションの SyncRoot で実行する必要があります。これにより、他のオブジェクトから派生したコレクションの操作が正常に実行されます。特に、コレクションを同時に変更する可能性がある他のスレッドとの間で、正常な同期を維持します。SyncRoot の実装によっては、Array 自体を返す場合もあります。

コレクションの列挙処理は、本質的にはスレッド セーフな処理ではありません。コレクションが同期されている場合でも、他のスレッドがそのコレクションを変更する可能性はあり、そのような状況が発生すると列挙子は例外をスローします。列挙処理を確実にスレッド セーフに行うには、列挙中にコレクションをロックするか、他のスレッドによって行われた変更によってスローされる例外をキャッチします。

このプロパティ値を取得することは、O(1) 操作になります。

使用例

列挙処理中に SyncRoot プロパティを使用して配列をロックする方法を次のコード例に示します。

Visual Basic

Dim myArray As Array = New
 Integer() { 1, 2, 4 }
SyncLock(myArray.SyncRoot) 
    For Each item As Object
 In myArray
        Console.WriteLine(item)
    Next
End SyncLock

C#

Array myArray = new int[] { 1, 2, 4 };
lock(myArray.SyncRoot) 
{
    foreach (Object item in myArray)
        Console.WriteLine(item);
}

C++

Array^ myArray = gcnew array<Int32> { 1, 2, 4 };
try
{
    Monitor::Enter(myArray->SyncRoot); 
        
    for each (Int32 item in myArray)
        Console::WriteLine(item);
}
finally
{
    Monitor::Exit(myArray->SyncRoot);
}

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Array クラス
Array メンバ
System 名前空間
Array.IsSynchronized プロパティ