Dictionary<TKey,TValue>.KeyCollection.IEnumerable.GetEnumerator Метод

Определение

Пространство имен:

System.Collections.Generic

Сборка:

System.Collections.dll

Исходный код:

Dictionary.cs

Возвращает перечислитель, который осуществляет итерацию по коллекции.

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

System.Collections.IEnumerator IEnumerable.GetEnumerator ();

abstract member System.Collections.IEnumerable.GetEnumerator : unit -> System.Collections.IEnumerator
override this.System.Collections.IEnumerable.GetEnumerator : unit -> System.Collections.IEnumerator

Function GetEnumerator () As IEnumerator Implements IEnumerable.GetEnumerator

Возвращаемое значение

IEnumerator

Объект IEnumerator, который может использоваться для итерации элементов коллекции.

Реализации

GetEnumerator()

Комментарии

Оператор foreach языка C# (for each в C++, For Each в Visual Basic) скрывает сложность перечислителей. Поэтому рекомендуется вместо непосредственного использования перечислителя применять ключевое слово foreach.

Перечислители могут использоваться для чтения данных в коллекции, но не для ее изменения.

Изначально перечислитель располагается перед первым элементом коллекции. Метод Reset также переводит перечислитель в эту позицию. В этой позиции значение свойства Current не определено. Поэтому необходимо вызвать метод MoveNext, чтобы переместить перечислитель к первому элементу коллекции до считывания значения свойства Current.

Current возвращает тот же объект, пока не будет вызван метод MoveNext или Reset. MoveNext задает Current в качестве значения для следующего элемента.

Если MoveNext передает конец коллекции, перечислитель располагается после последнего элемента в коллекции и MoveNext возвращает .false Если перечислитель находится в этой позиции, последующие вызовы также MoveNext возвращают false. Если последний вызов MoveNext возвращал false, Current значение не определено. Чтобы снова задать в качестве значения свойства Current первый элемент коллекции, можно последовательно вызвать методы Reset иMoveNext.

Перечислитель является допустимым до тех пор, пока коллекция остается неизменной. Если в коллекцию вносятся изменения, такие как добавление элементов или изменение емкости, перечислитель становится безвозвратно недействительным и следующий вызов MoveNext или IEnumerator.Reset вызывает исключение InvalidOperationException.

Только .NET Core 3.0 и более поздних версий: единственными изменяемые методы, которые не делают перечислители недействительными, являются Remove и Clear.

У перечислителя нет эксклюзивного доступа к коллекции, поэтому перечисление коллекции не является потокобезопасной процедурой. Чтобы гарантировать потокобезопасность, можно заблокировать коллекцию на время всего перечисления. Чтобы разрешить доступ к коллекции из нескольких потоков для чтения и записи, необходимо реализовать собственную синхронизацию.

Реализации коллекций по умолчанию в System.Collections.Generic не синхронизируются.

Этот метод является операцией O(1).

См. также раздел

• IEnumerator