PostSharpAPI ReferencePost­Sharp.​AspectsOn­Method­Boundary­AspectOn­Yield
Open sandboxFocus

OnMethodBoundaryAspect.OnYield Method

OnYield(MethodExecutionArgs)

Method executed when a state machine yields, as the result of a yield return or await statement.

Declaration
[MethodExecutionAdviceOptimization]
[RequiresMethodExecutionAdviceAnalysis]
[RequiresDebuggerEnhancement]
[HasInheritedAttribute]
public virtual void OnYield(MethodExecutionArgs args)
Parameters
Type Name Description
MethodExecutionArgs args

Event arguments specifying which method is being executed and which are its arguments. In iterator methods, the YieldValue property gives access to the operand of the yield return statement.

Implements
IOnStateMachineBoundaryAspect.OnYield(MethodExecutionArgs)
Remarks

In iterator methods, this advise is exactly executed at the yield return statement.

In async methods, the advice is executed just after the state machine starts waiting as a result of the await statement. In case the operand of the await statement is an operation that completed synchronously, the state machine does not yield, and the OnYield(MethodExecutionArgs) advise won't be invoked.