maeEnableRun
maeEnableRun(
[ ?run t_run ]
[ ?enable g_enable ]
[ ?session t_session ]
[ ?all g_all ]
)
=> t / nil
Description
Enable or disables the runs in a run plan.
Arguments
|
?run t_run
|
Name of run to be enabled or disabled in the run plan.
By default, this argument is set to "". If not specified, the function looks for ?all. If both are not specified, returns an error.
|
|
?enable g_enable
|
A Boolean value that specifies the status to be set for the specified runs in the run plan. By default, this argument is set to t.
The valid values are t and nil.
|
|
?session t_session
|
Name of the session. If not specified, the current session is used.
|
|
?all g_all
|
A Boolean value that specifies whether to enable or disable all runs in the run plan. By default, this argument is set to nil.
The valid values are t and nil.
|
Value Returned
|
t
|
The status of the specified runs is successfully changed.
|
|
nil
|
The status of the runs is not changed.
|
Examples
Enables run Run.0 in the run plan:
maeEnableRun(?run "Run.0")
=> t
Disables run Run.0 in the run plan:
maeEnableRun(?run "Run.0" ?enable nil)
=> t
Enables all runs in the run plan:
maeEnableRun(?all t)
=> t
Disables all runs in the run plan:
maeEnableRun(?all t ?enable nil)
=> t
Related Topics
Modifying a Run in the Run Plan
Return to top
