Stops a timer session that was previously started using a Start Timer action. The elapsed time is output to a user-specified variable using a specified time scale. Used in conjunction with the Start Timer action to record the elapsed execution time of a step or series of steps that may perform time sensitive operations.
This action stops the timer and records the elapsed time in a variable. To record the elapsed time without stopping the timer, use the Read Timer action.
Declaration
<AMSTOPTIMER SESSION="Text" RESULTVARIABLE="Text" SCALE="Text" />
Example
<AMVARIABLE NAME="timeVar"></AMVARIABLE>
<AMSTARTTIMER SESSION="myTime" />
<AMREADTIMER SESSION="myTime" RESULTVARIABLE="timeVar" />
<AMSTOPTIMER SESSION="myTime" RESULTVARIABLE="timeVar" />
See Also: Start Timer, Pause Task, Wait for File, Wait for Process
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Timer Name |
Text |
Yes |
TimerSession1 |
SESSION="TimeSess2" |
The name of the timer session previously established by a Start Timer step that should be stopped. Timer sessions allow several timers to be running simultaneously. The default value is TimerSession1. |
|
Populate Variable With Elapsed Time |
Text |
Yes |
(Empty) |
RESULTVARIABLE="myVar" |
The variable to populate with the timer reading. |
|
Time Scale |
Text (options) |
No |
Seconds |
SCALE="minutes" |
The scale to be used in calculating the time. The available options are:
|