IteratorStateMachineAttribute Klas

Definitie

Naamruimte:

System.Runtime.CompilerServices

Assembly:

mscorlib.dll

Geeft aan of een methode in Visual Basic is gemarkeerd met de Iterator modifier.

public ref class IteratorStateMachineAttribute sealed : System::Runtime::CompilerServices::StateMachineAttribute

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)]
[System.Serializable]
public sealed class IteratorStateMachineAttribute : System.Runtime.CompilerServices.StateMachineAttribute

[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)>]
[<System.Serializable>]
type IteratorStateMachineAttribute = class
    inherit StateMachineAttribute

Public NotInheritable Class IteratorStateMachineAttribute
Inherits StateMachineAttribute

Overname

Object

Attribute

StateMachineAttribute

IteratorStateMachineAttribute

Kenmerken

AttributeUsageAttribute SerializableAttribute

Voorbeelden

In het volgende voorbeeld ziet u hoe u kunt bepalen of een methode een iterator-methode is. Voer in het voorbeeld IsIteratorMethod de volgende stappen uit:

• Hiermee verkrijgt u een MethodInfo object voor de methodenaam met behulp van Type.GetMethod.

• Hiermee haalt u een Type object voor het kenmerk op met behulp van GetType Operator.

• Hiermee verkrijgt u een kenmerkobject voor de methode en het kenmerktype met behulp van MethodInfo.GetCustomAttribute. Als GetCustomAttributeNothing (Visual Basic) retourneert, bevat de methode het kenmerk niet.

Imports System.Collections.Generic
Imports System.Reflection
Imports System.Threading.Tasks
Imports System.Runtime.CompilerServices


Module Module1

    ' This class is used by the code below to discover method attributes.
    Public Class TheClass
        Public Async Function AsyncMethod() As Task(Of Integer)
            Await Task.Delay(5)
            Return 1
        End Function

        Public Iterator Function IteratorMethod() As IEnumerable(Of Integer)
            Yield 1
            Yield 2
        End Function

        Public Function RegularMethod() As Integer
            Return 0
        End Function
    End Class


    Private Function IsAsyncMethod(classType As Type, methodName As String)
        ' Obtain the method with the specified name.
        Dim method As MethodInfo = classType.GetMethod(methodName)

        Dim attType As Type = GetType(AsyncStateMachineAttribute)

        Dim attrib = CType(method.GetCustomAttribute(attType), AsyncStateMachineAttribute)
        ' The above variable contains the StateMachineType property.

        Return (attrib IsNot Nothing)
    End Function

    Private Function IsIteratorMethod(classType As Type, methodName As String)
        ' Obtain the method with the specified name.
        Dim method As MethodInfo = classType.GetMethod(methodName)

        Dim attType As Type = GetType(IteratorStateMachineAttribute)

        ' Obtain the custom attribute for the method.
        ' The value returned contains the StateMachineType property.
        ' Nothing is returned if the attribute isn't present for the method.
        Dim attrib = CType(method.GetCustomAttribute(attType), IteratorStateMachineAttribute)

        Return (attrib IsNot Nothing)
    End Function

    Private Sub ShowResult(classType As Type, methodName As String)
        Console.Write((methodName & ": ").PadRight(16))

        If IsAsyncMethod(classType, methodName) Then
            Console.WriteLine("Async method")
        ElseIf IsIteratorMethod(classType, methodName) Then
            Console.WriteLine("Iterator method")
        Else
            Console.WriteLine("Regular method")
        End If

        ' Note: The IteratorStateMachineAttribute applies to Visual Basic methods
        ' but not C# methods.
    End Sub

    Sub Main()
        ShowResult(GetType(TheClass), "AsyncMethod")
        ShowResult(GetType(TheClass), "IteratorMethod")
        ShowResult(GetType(TheClass), "RegularMethod")

        Console.ReadKey()
    End Sub

    '   AsyncMethod:    Async method
    '   IteratorMethod: Iterator method
    '   RegularMethod:  Regular method

End Module

Opmerkingen

U moet het IteratorStateMachine kenmerk niet toepassen op methoden in uw code. Voor methoden in Visual Basic met de Iterator modifier, past de compiler het kenmerk IteratorStateMachine toe in de IL die wordt verzonden.

Wanneer een methode (MethodName) in Visual Basic de Iterator modifier heeft, verzendt de compiler IL die een statusmachinestructuur bevat. Deze structuur bevat de code in de methode. Dat IL bevat ook een stub-methode (MethodName) die de statusmachine aanroept. De compiler voegt het IteratorStateMachine kenmerk toe aan de stub-methode, zodat hulpprogramma's de bijbehorende statusmachine kunnen identificeren. Details van de verzonden IL kunnen veranderen in toekomstige versies van de compilers.

Een iteratormethode voert een aangepaste iteratie uit voor een verzameling met behulp van de instructie Yield (Visual Basic) om elk element één voor één te retourneren. Zie Iterators voor meer informatie.

Note

U kunt niet gebruiken IteratorStateMachineAttribute om te testen of een methode een iterator-methode is in C#.

Constructors

Name	Description
IteratorStateMachineAttribute(Type)	Initialiseert een nieuw exemplaar van de IteratorStateMachineAttribute klasse.

Eigenschappen

Name	Description
StateMachineType	Retourneert het typeobject voor het onderliggende statusmachinetype dat is gegenereerd door de compiler om de methode voor de statusmachine te implementeren. (Overgenomen van StateMachineAttribute)
TypeId	Wanneer deze wordt geïmplementeerd in een afgeleide klasse, krijgt u Attributehiervoor een unieke id. (Overgenomen van Attribute)

Methoden

Name	Description
Equals(Object)	Retourneert een waarde die aangeeft of dit exemplaar gelijk is aan een opgegeven object. (Overgenomen van Attribute)
GetHashCode()	Retourneert de hash-code voor dit exemplaar. (Overgenomen van Attribute)
GetType()	Hiermee haalt u de Type huidige instantie op. (Overgenomen van Object)
IsDefaultAttribute()	Wanneer deze wordt overschreven in een afgeleide klasse, geeft u aan of de waarde van dit exemplaar de standaardwaarde is voor de afgeleide klasse. (Overgenomen van Attribute)
Match(Object)	Wanneer deze wordt overschreven in een afgeleide klasse, wordt een waarde geretourneerd die aangeeft of dit exemplaar gelijk is aan een opgegeven object. (Overgenomen van Attribute)
MemberwiseClone()	Hiermee maakt u een ondiepe kopie van de huidige Object. (Overgenomen van Object)
ToString()	Retourneert een tekenreeks die het huidige object vertegenwoordigt. (Overgenomen van Object)

Expliciete interface-implementaties

Name	Description
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Hiermee wordt een set namen toegewezen aan een bijbehorende set verzend-id's. (Overgenomen van Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Hiermee haalt u de typegegevens voor een object op, die kan worden gebruikt om de typegegevens voor een interface op te halen. (Overgenomen van Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Hiermee wordt het aantal type-informatieinterfaces opgehaald dat een object biedt (0 of 1). (Overgenomen van Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Biedt toegang tot eigenschappen en methoden die door een object worden weergegeven. (Overgenomen van Attribute)

Zie ook

• AsyncStateMachineAttribute
• StateMachineType