Iterador (Visual Basic)

Especifica que una función o Get un accessor es un iterador.

Comentarios

Un iterador realiza una iteración personalizada en una colección. Un iterador usa la instrucción Yield para devolver cada elemento de la colección de uno en uno. Cuando se Yield alcanza una instrucción , se conserva la ubicación actual en el código. La ejecución se reinicia desde esa ubicación la próxima vez que se llama a la función del iterador.

Un iterador se puede implementar como una función o como Get un accessor de una definición de propiedad. El modificador aparece en la declaración de la función o el Iterator Get accessor del iterador.

Para llamar a un iterador desde el código de cliente, use un elemento For Each... Instrucción Next.

El tipo de valor devuelto de una función o un accessor de iterador Get puede ser , , o IEnumerable IEnumerable<T> IEnumerator IEnumerator<T> .

Un iterador no puede tener ByRef ningún parámetro.

Un iterador no puede aparecer en un evento, un constructor de instancia, un constructor estático o un destructor estático.

Un iterador puede ser una función anónima. Para obtener más información, consulta Iteradores.

Uso

El modificador Iterator se puede utilizar en los contextos siguientes:

Ejemplo 1

En el ejemplo siguiente se muestra una función de iterador. La función iterador tiene una Yield instrucción que está dentro de una instrucción For... Bucle siguiente. Cada iteración del cuerpo de instrucción For Each de crea una llamada a la función de Main Power iterador. Cada llamada a la función de iterador prosigue con la siguiente ejecución de la instrucción Yield, que se produce durante la siguiente iteración del bucle For…Next.

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

Ejemplo 2

En el ejemplo siguiente se muestra un descriptor de acceso Get que es un iterador. El Iterator modificador está en la declaración de propiedad.

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

Para obtener ejemplos adicionales, vea Iteradores.

Consulta también