StateMachine.SendTriggerEvent Method (Object, EventArgs)

StateMachineSendTriggerEvent Method (Object, EventArgs)

Enqueues a trigger event together with additional parameters and starts processing the state machine, if not already inside a processing. As a result a transition may be executed by invoking exit actions, changing the active state and invoking entry actions.

Namespace: StaMa
Assembly: StaMa (in StaMa.dll) Version: 2.3.1.7

Syntax

C++

Copy

public int SendTriggerEvent(
	Object triggerEvent,
	EventArgs eventArgs
)

Public Function SendTriggerEvent ( 
	triggerEvent As Object,
	eventArgs As EventArgs
) As Integer

public:
int SendTriggerEvent(
	Object^ triggerEvent, 
	EventArgs^ eventArgs
)

member SendTriggerEvent : 
        triggerEvent : Object * 
        eventArgs : EventArgs -> int

Parameters

triggerEvent: Type: SystemObject
An Object that represents the trigger event that is sent to the state machine or null to trigger the evaluation of transitions having an "any" event. The Object will be compared using Equals(Object) to the value of the TriggerEvent property of the active Transition instances.
eventArgs: Type: Microsoft.SPOTEventArgs
An EventArgs instance that carries additional parameters accompanying the trigger event. The additional parameters may be used in the guard conditions of the active Transition instances.

Return Value

Type: Int32
The number of executed state machine steps.

Reference

StateMachine Class

SendTriggerEvent Overload

StaMa Namespace