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

Определение

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

System.Collections.Generic

Сборка:

System.Collections.dll

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

Dictionary.cs

Возвращает перечислитель, осуществляющий перебор элементов списка Dictionary<TKey,TValue>.

public:
 System::Collections::Generic::Dictionary<TKey, TValue>::Enumerator GetEnumerator();

public System.Collections.Generic.Dictionary<TKey,TValue>.Enumerator GetEnumerator ();

member this.GetEnumerator : unit -> System.Collections.Generic.Dictionary<'Key, 'Value>.Enumerator

Public Function GetEnumerator () As Dictionary(Of TKey, TValue).Enumerator

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

Dictionary<TKey,TValue>.Enumerator

Структура Dictionary<TKey,TValue>.Enumerator для Dictionary<TKey,TValue>.

Комментарии

Для целей перечисления каждый элемент является структурой KeyValuePair<TKey,TValue> , представляющей значение и его ключ.

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

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

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

Свойство Current возвращает тот же элемент до MoveNext вызова метода . MoveNext задает Current в качестве значения для следующего элемента.

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

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

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

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

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

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

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

• Dictionary<TKey,TValue>.Enumerator
• IEnumerator<T>