StateMachineAttribute Class

Definition

Namespace:

System.Runtime.CompilerServices

Assemblies:

netstandard.dll, System.Runtime.dll

Source:

StateMachineAttribute.cs

Allows you to determine whether a method is a state machine method.

public ref class StateMachineAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)]
public class StateMachineAttribute : Attribute

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

Public Class StateMachineAttribute
Inherits Attribute

Inheritance

Object

Attribute

StateMachineAttribute

Derived

System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute

System.Runtime.CompilerServices.AsyncStateMachineAttribute

System.Runtime.CompilerServices.IteratorStateMachineAttribute

Attributes

AttributeUsageAttribute

Remarks

You should not apply the StateMachine attribute to methods in your code. For methods that are state machine methods, the compiler will apply the AsyncStateMachineAttribute or IteratorStateMachineAttribute in the emitted IL.

When checking whether a method is a state machine method, it is preferable to instead check for following attributes, which are derived from StateMachineAttribute:

• AsyncStateMachineAttribute

• IteratorStateMachineAttribute

Note

StateMachineAttribute cannot be used to check whether a method is a state machine method if the method is an iterator method in C#.

Constructors

Name	Description
StateMachineAttribute(Type)	Initializes a new instance of the StateMachineAttribute class.

Properties

Name	Description
StateMachineType	Returns the type object for the underlying state machine type that was generated by the compiler to implement the state machine method.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Name	Description
Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)