maeDeleteRun
maeDeleteRun(
[ ?run l_run ] | [ ?all g_all ]
[ ?session t_session ]
)
=> t / nil
Description
Deletes the specified runs from the run plan.
Arguments
|
?run l_run
|
A list containing the names of the runs to be deleted.
By default, this argument is set to nil. If not specified, the function does not delete any run and returns nil.
|
|
?all g_all
|
A Boolean value that specifies whether to delete all runs available in the given session. By default, this argument is set to nil.
The valid values are t and nil.
|
|
?session t_session
|
Name of the session. If not specified, the current session is used.
|
Value Returned
|
t
|
The specified run plan is successfully deleted.
|
|
nil
|
Indicates an error.
|
Examples
Deletes two runs, Run.0 and Run.1, from the run plan of the active setup:
maeDeleteRun(?run '("Run.0" "Run.1"))
=> t
Deletes all runs from the run plan:
maeDeleteRun(?all t)
=> t
Related Topics
Modifying a Run in the Run Plan
Return to top
