RemoveTimer

Metreos.Providers.TimerFacility.RemoveTimer

Summary

RemoveTimer will cancel the specified timer.

Usage

AddTriggerTimer and AddNonTriggerTimer return a timer ID, which can be used as the TimerId action parameter of this action.

Due to the queuing mechanism of the Application Runtime Environment, a timer set with the AddNonTriggerTimer could have already fired and the timer event is still queued for processing, even though you have used the RemoveTimer action. While this scenario is extremely unlikely, it is still possible and the logic of your application should account for it (for instance, you could set a boolean global variable indicating that the timer has been removed when you use the RemoveTimer event, and check the value of that boolean variable in the TimerFire event.

Remarks

If the timer results in a no handler, then the Timer Provider will remove the timer automatically.

Action Parameters
Parameter Name.NET TypeDefaultDescription
TimerId *System.StringThe identifier to the timer to remove. This value originates from either the AddTriggerTimer or AddNonTriggerTimer action.
TimeoutSystem.Int32The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.

No Result Data

Branch Conditions 

Success

No description.

Failure

No description.

Timeout

No description.