Dictionary<TKey,TValue>.KeyCollection.GetEnumerator Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Возвращает перечислитель, осуществляющий перебор элементов списка Dictionary<TKey,TValue>.KeyCollection.
public:
System::Collections::Generic::Dictionary<TKey, TValue>::KeyCollection::Enumerator GetEnumerator();
public System.Collections.Generic.Dictionary<TKey,TValue>.KeyCollection.Enumerator GetEnumerator ();
member this.GetEnumerator : unit -> System.Collections.Generic.Dictionary<'Key, 'Value>.KeyCollection.Enumerator
Public Function GetEnumerator () As Dictionary(Of TKey, TValue).KeyCollection.Enumerator
Возвращаемое значение
Новый объект Dictionary<TKey,TValue>.KeyCollection.Enumerator для Dictionary<TKey,TValue>.KeyCollection.
Комментарии
Оператор 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).