AddParameter

Description:              This function adds an existing variable as a module parameter and returns the number of parameters in the module.

Warning:               This function may cause irrecoverable alteration of your application. It should be used only by advanced programmers.

Returns:                    Numeric: the number of parameters in a module.

Usage:                       Script

Format:                      AddParameter(Variable, Position)

Parameters:             Variable   { numeric }  { required }  { no default: }

                                                Variable is any expression that returns a variable value such as AddVariable(…). This variable will become a parameter in the module where it is defined.

                                    Position    { numeric }  { required }  { no default: }

                                                Position is any numeric expression giving the position in the parameter list where Variable will be inserted. Position 1 is the first parameter.

                             Inserting a variable past the end of the list will append the variable to the parameter list.

Comments:               The return value of AddParameter is the number of parameters in the module after the addition, or "-1" if it failed.

                             Caution:  It is not recommended that you attempt to insert a variable in the parameter list twice, as undefined behaviour may result.

See Also:

ConstCount | NumParms | SetOneParmText | SetParameter | SetParmText | AddVariable