Breyta

Deila með

Stack<T>.Enumerator Struct

  • Reference

Definition

Namespace:
System.Collections.Generic
Assembly:
System.Collections.dll
Assembly:
System.dll
Assembly:
netstandard.dll
Source:
Stack.cs
Source:
Stack.cs
Source:
Stack.cs

Enumerates the elements of a Stack<T>.

public: value class Stack<T>::Enumerator : System::Collections::Generic::IEnumerator<T>
public struct Stack<T>.Enumerator : System.Collections.Generic.IEnumerator<T>
[System.Serializable]
public struct Stack<T>.Enumerator : System.Collections.Generic.IEnumerator<T>
type Stack<'T>.Enumerator = struct
    interface IEnumerator<'T>
    interface IEnumerator
    interface IDisposable
[<System.Serializable>]
type Stack<'T>.Enumerator = struct
    interface IEnumerator<'T>
    interface IDisposable
    interface IEnumerator
Public Structure Stack(Of T).Enumerator
Implements IEnumerator(Of T)

Type Parameters

T
Inheritance
Object
ValueType
Stack<T>.Enumerator
Attributes
SerializableAttribute
Implements
IEnumerator<T> IEnumerator IDisposable

Remarks

The foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of the enumerators. 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. At this position, Current is undefined. Therefore, you must call MoveNext to advance the enumerator to the first element of the collection before reading the value of Current.

Current returns the same object until MoveNext is called. MoveNext sets Current to the next element.

If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. When the enumerator is at this position, subsequent calls to MoveNext also return false. If the last call to MoveNext returned false, Current is undefined. You cannot set Current to the first element of the collection again; you must create a new enumerator instance instead.

An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to MoveNext or IEnumerator.Reset throws an InvalidOperationException.

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.

Default implementations of collections in System.Collections.Generic are not synchronized.

Properties

Current

Gets the element at the current position of the enumerator.

Methods

Dispose()

Releases all resources used by the Stack<T>.Enumerator.
MoveNext()

Advances the enumerator to the next element of the Stack<T>.

Explicit Interface Implementations

IEnumerator.Current

Gets the element at the current position of the enumerator.
IEnumerator.Reset()

Sets the enumerator to its initial position, which is before the first element in the collection. This class cannot be inherited.

Applies to

See also