IEnumerable.GetEnumerator メソッド

コレクションを反復処理できる列挙子を返します。

Function GetEnumerator() As IEnumerator
[C#]
IEnumerator GetEnumerator();
[C++]
IEnumerator* GetEnumerator();
[JScript]
function GetEnumerator() : IEnumerator;

戻り値

コレクションを反復処理するために使用できる IEnumerator 。

解説

列挙子は、コレクション内のデータを読み取るためだけに使用できます列挙子を使用して基になるコレクションを変更することはできません。

初期状態では、列挙子はコレクションの最初の要素の前に位置しています。 Reset を実行した場合も、列挙子はこの位置に戻されます。この位置で Current を呼び出すと、例外がスローされます。したがって、 Current の値を読み取る前に、 MoveNext を呼び出して、コレクションの最初の要素に列挙子を進める必要があります。

Current は、 MoveNext または Reset が呼び出されるまでは同じオブジェクトを返します。 MoveNext は、 Current を次の要素に位置付けます。

コレクションの末尾を過ぎると列挙子はコレクションの最後の要素の後に位置付けられ、 MoveNext を呼び出すと false が返されます。 MoveNext への最後の呼び出しで false が返された場合は、 Current を呼び出すと例外がスローされます。 Current をコレクションの最初の要素に再度位置付けるには、 Reset を呼び出し、次に MoveNext を呼び出します。

列挙子は、コレクションが変更されない限り有効です。要素の追加、変更、削除などの変更がコレクションに対して実行されると、列挙子は無効状態になることがあり、次に MoveNext または Reset を呼び出すと、 InvalidOperationException がスローされることがあります。コレクションが MoveNext と Current の間で変更された場合、列挙子が既に無効になっていても、 Current は設定した要素を返します。

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

必要条件

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ, .NET Compact Framework - Windows CE .NET, Common Language Infrastructure (CLI) Standard

参照

IEnumerable インターフェイス | IEnumerable メンバ | System.Collections 名前空間 | IEnumerator