axlGetRunOptions

axlGetRunOptions( 
x_hsdb 
t_runModeName
) 
=> l_list / nil 

Description

Returns a list containing a handle to all run option names for the specified run mode.

Arguments

x_hsdb	Setup database handle.
t_runModeName	Name of the run mode for which you want to get run options. The name of the run mode must be same as it is displayed in the Run Mode list in GUI.

Value Returned

l_list	List containing a handle to all the run options in the setup database and a list of all run option names.
nil	The command was unsuccessful.

Examples

The following example retreives the names of run options for the Monte Carlo run mode:

session = axlGetWindowSession()
x_mainSDB = axlGetMainSetupDB(session)
axlGetRunOptions( x_mainSDB "Monte Carlo Sampling")

(1452 ("dutsummary" "ignoreflag" "mcmethod" "mcnumpoints" "mcnumbins"
    "mcStopEarly" "mcStopMethod" "samplingmode" "saveprocess" "savemismatch"
    "mcreferencepoint" "donominal" "saveallplots" "montecarloseed"
    "mcstartingrunnumber" "mcYieldTarget" "mcYieldAlphaLimit"    )
) 
; you can further get the value of one of the run options, as shown below.
x_runOption = axlGetRunOption(x_mainSDB "Monte Carlo Sampling" "mcnumpoints")
axlGetRunOptionValue(x_runOption) 
"200"

Return to top