StringCollection.SyncRoot プロパティ

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

StringCollection.SyncRoot プロパティ

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

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

Visual Basic (宣言)

Public ReadOnly Property
 SyncRoot As Object

Visual Basic (使用法)

Dim instance As StringCollection
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

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

解説

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

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

列挙処理中に SyncRoot を使用してコレクションをロックする方法を次のコード例に示します。

C#

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

Visual Basic

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

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

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