IEnumerator.Current Property

public:
 property System::Object ^ Current { System::Object ^ get(); };

public object Current { get; }

public object? Current { get; }

member this.Current : obj

Public ReadOnly Property Current As Object

Property Value

The element in the collection at the current position of the enumerator.

Examples

The following code example demonstrates the implementation of the IEnumerator interfaces for a custom collection. In this example, Current is not explicitly called, but it is implemented to support the use of foreach (for each in Visual Basic). This code example is part of a larger example for the IEnumerator interface.

// When you implement IEnumerable, you must also implement IEnumerator.
public class PeopleEnum : IEnumerator
{
 public Person[] _people;

 // Enumerators are positioned before the first element
 // until the first MoveNext() call.
 int position = -1;

 public PeopleEnum(Person[] list)
 {
 _people = list;
 }

 public bool MoveNext()
 {
 position++;
 return (position < _people.Length);
 }

 public void Reset()
 {
 position = -1;
 }

 object IEnumerator.Current
 {
 get
 {
 return Current;
 }
 }

 public Person Current
 {
 get
 {
 try
 {
 return _people[position];
 }
 catch (IndexOutOfRangeException)
 {
 throw new InvalidOperationException();
 }
 }
 }
}

' When you implement IEnumerable, you must also implement IEnumerator.
Public Class PeopleEnum
 Implements IEnumerator

 Public _people() As Person

 ' Enumerators are positioned before the first element
 ' until the first MoveNext() call.
 Dim position As Integer = -1

 Public Sub New(ByVal list() As Person)
 _people = list
 End Sub

 Public Function MoveNext() As Boolean Implements IEnumerator.MoveNext
 position = position + 1
 Return (position < _people.Length)
 End Function

 Public Sub Reset() Implements IEnumerator.Reset
 position = -1
 End Sub

 Public ReadOnly Property Current() As Object Implements IEnumerator.Current
 Get
 Try
 Return _people(position)
 Catch ex As IndexOutOfRangeException
 Throw New InvalidOperationException()
 End Try
 End Get
 End Property
End Class

Remarks

Current is undefined under any of the following conditions:

• The enumerator is positioned before the first element in the collection, immediately after the enumerator is created. MoveNext must be called to advance the enumerator to the first element of the collection before reading the value of Current.

• The last call to MoveNext returned false, which indicates the end of the collection.

• The enumerator is invalidated due to changes made in the collection, such as adding, modifying, or deleting elements.

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

See also

• MoveNext()
• Reset()