Iterator (Visual Basic)

  • Artikel

Gibt an, dass eine Funktion oder Get ein Accessor ein Iterator ist.

Bemerkungen

Ein Iterator führt eine benutzerdefinierte Iteration über eine Sammlung aus. Ein Iterator verwendet eine Yield-Anweisung, um jedes Element der Auflistung separat zurückzugeben. Wenn eine Yield-Anweisung erreicht wird, wird die aktuelle Position im Code gespeichert. Wenn die Iteratorfunktion das nächste Mal aufgerufen wird, wird die Ausführung von dieser Position neu gestartet.

Ein Iterator kann als Funktion oder als Get Accessor einer Eigenschaftsdefinition implementiert werden. Der Iterator Modifizierer wird in der Deklaration der Iteratorfunktion oder Get des Accessors angezeigt.

Sie rufen einen Iterator im Clientcode mithilfe einer foreach Anweisung auf.

Der Rückgabetyp einer Iteratormethode oder einer Get-Zugriffsmethode kann IEnumerable, IEnumerable<T>, IEnumerator oder IEnumerator<T> sein.

Ein Iterator kann keine ByRef Parameter haben.

Ein Iterator kann nicht in einem Ereignis, Instanzenkonstruktor, statischen Konstruktor oder statischen Destruktor vorkommen.

Ein Iterator kann eine anonyme Funktion sein. Weitere Informationen finden Sie unter Iteratoren.

Verwendung

Der Iterator-Modifizierer kann in folgenden Kontexten verwendet werden:

Beispiel 1

Im folgenden Beispiel wird eine Iteratorfunktion veranschaulicht. Die Iteratormethode verfügt über eine Yield-Anweisung in einer For…Next-Schleife. Jede Iteration des For Each-Anweisungstexts in Main erzeugt einen Aufruf an die Power-Iteratorfunktion. Jeder Aufruf der Iteratorfunktion führt bei der nächsten Iteration der Yield-Schleife zur nächsten Ausführung der For…Next-Anweisung.

Sub Main()
    For Each number In Power(2, 8)
        Console.Write(number & " ")
    Next
    ' Output: 2 4 8 16 32 64 128 256
    Console.ReadKey()
End Sub

Private Iterator Function Power(
ByVal base As Integer, ByVal highExponent As Integer) _
As System.Collections.Generic.IEnumerable(Of Integer)

    Dim result = 1

    For counter = 1 To highExponent
        result = result * base
        Yield result
    Next
End Function

Beispiel 2

Das folgende Beispiel zeigt einen Get-Accessor, der ein Iterator ist. Der Iterator Modifizierer befindet sich in der Eigenschaftsdeklaration.

Sub Main()
    Dim theGalaxies As New Galaxies
    For Each theGalaxy In theGalaxies.NextGalaxy
        With theGalaxy
            Console.WriteLine(.Name & "  " & .MegaLightYears)
        End With
    Next
    Console.ReadKey()
End Sub

Public Class Galaxies
    Public ReadOnly Iterator Property NextGalaxy _
    As System.Collections.Generic.IEnumerable(Of Galaxy)
        Get
            Yield New Galaxy With {.Name = "Tadpole", .MegaLightYears = 400}
            Yield New Galaxy With {.Name = "Pinwheel", .MegaLightYears = 25}
            Yield New Galaxy With {.Name = "Milky Way", .MegaLightYears = 0}
            Yield New Galaxy With {.Name = "Andromeda", .MegaLightYears = 3}
        End Get
    End Property
End Class

Public Class Galaxy
    Public Property Name As String
    Public Property MegaLightYears As Integer
End Class

Weitere Beispiele finden Sie unter Iteratoren.

Siehe auch