maeCreateNewRun
maeCreateNewRun(
[ ?session t_session ]
[ ?runName t_runName ]
[ ?newRunFromActiveSetup g_newRunFromActiveSetup ]
)
=> t / nil
Description
Creates a new run in the run plan.
Arguments
|
?session t_session
|
Name of the session. If not specified, the current session is used.
|
|
?runName t_runName
|
Name to be used for the new run created by this function. If no name is specified, the run is named as Run.x where, x is an incremental number.
|
|
?newRunFromActiveSetup g_newRunFromActiveSetup
|
|
|
Specifies whether to copy the setup from the active setup to the newly created run.
-
t: Copies the setup from the active setup to the newly created run. -
nil: Does not copy the setup from the active setup to the newly created run and creates a blank run. This is the default.
|
Value Returned
|
t
|
A new run is created.
|
|
nil
|
Indicates an error.
|
Examples
Creates a new run named myrun in which the setup is copied from the active setup:.
maeCreateNewRun(?runName "myrun" ?newRunFromActiveSetup t)
Creates a blank new run.
maeCreateNewRun(?runName "Run.2")
=> t
Related Topics
Creating a Run by Copying Another Run
Return to top
