Dictionary<TKey,TValue>.IEnumerable.GetEnumerator メソッド

定義

コレクションを反復処理する列挙子を返します。Returns an enumerator that iterates through the collection.

 virtual System::Collections::IEnumerator ^ System.Collections.IEnumerable.GetEnumerator() = System::Collections::IEnumerable::GetEnumerator;
System.Collections.IEnumerator IEnumerable.GetEnumerator ();
Function GetEnumerator () As IEnumerator Implements IEnumerable.GetEnumerator

戻り値

コレクションを反復処理するために使用できる IEnumeratorAn IEnumerator that can be used to iterate through the collection.

実装

注釈

C#言語の foreach ステートメント (for each ではC++、For Each Visual Basic) により、列挙子の複雑さが隠蔽されます。The foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of enumerators. したがって、列挙子を直接操作するのではなく、foreach を使用することをお勧めします。Therefore, using foreach is recommended, instead of directly manipulating the enumerator.

列挙子を使用すると、コレクション内のデータを読み取ることができますが、基になるコレクションを変更することはできません。Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

最初、列挙子はコレクションの先頭の要素の前に位置付けられます。Initially, the enumerator is positioned before the first element in the collection. Reset メソッドは、この位置に列挙子を戻します。The Reset method also brings the enumerator back to this position. この位置では、Current プロパティは定義されていません。At this position, the Current property is undefined. そのため、MoveNext の値を読み取る前に、Current メソッドを呼び出し、列挙子をコレクションの最初の要素に進める必要があります。Therefore, you must call the MoveNext method to advance the enumerator to the first element of the collection before reading the value of Current.

Current プロパティは、MoveNext または Reset メソッドが呼び出されるまで、同じ要素を返します。The Current property returns the same element until either the MoveNext or Reset method is called. MoveNext は、Current を次の要素に設定します。MoveNext sets Current to the next element.

MoveNext がコレクションの末尾を通過した場合、列挙子がコレクション内の最後の要素の後に配置され、MoveNextfalse を返します。If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. 列挙子がこの位置にある場合、後続の MoveNext 呼び出しも false を返します。When the enumerator is at this position, subsequent calls to MoveNext also return false. MoveNext の最後の呼び出しが falseを返した場合、Current は定義されていません。If the last call to MoveNext returned false, Current is undefined. Current をコレクションの最初の要素にもう一度設定するには、Reset を呼び出してから MoveNext を呼び出します。To set Current to the first element of the collection again, you can call Reset followed by MoveNext.

列挙子は、コレクションが変更されない限り有効です。An enumerator remains valid as long as the collection remains unchanged. 要素の追加や容量の変更などの変更がコレクションに対して行われた場合、列挙子はなりに無効になり、次に MoveNext または IEnumerator.Reset を呼び出すと InvalidOperationExceptionがスローされます。If changes are made to the collection, such as adding elements or changing the capacity, the enumerator is irrecoverably invalidated and the next call to MoveNext or IEnumerator.Reset throws an InvalidOperationException.

.NET Core 3.0 + のみ: 列挙子を無効にしない変更メソッドのみが Remove および Clearます。.NET Core 3.0+ only: The only mutating methods which do not invalidate enumerators are Remove and Clear.

列挙子には、コレクションへの排他アクセスがありません。したがって、コレクションの列挙処理は本質的にスレッド セーフな処理ではありません。The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread safe procedure. 列挙処理でスレッド セーフを確保するために、列挙処理が終わるまでコレクションをロックできます。To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. コレクションに対し複数のスレッドがアクセスして読み取りや書き込みを行うことができるようにするには、独自に同期化を実装する必要があります。To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.

System.Collections.Generic 名前空間のコレクションの既定の実装は同期されません。Default implementations of collections in the System.Collections.Generic namespace are not synchronized.

このメソッドは、O(1) 操作です。This method is an O(1) operation.

適用対象

こちらもご覧ください