AddOptional

Description:              Adds a new statement to an action script and returns its own error code.

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

Returns:                    A new module value

Usage:                       Script

Format:                      AddOptional(NewStatement, Destination, Location, TextSize)

Parameters:             NewStatement   { text }  { required }  { no default: }

                                                NewStatement is any expression that returns a statement value. This is the value of the new script statement that was added.

                                    Destination   { text }  { required }  { no default: }

                                                Destination is any code value expression. Destination is the action that will receive NewStatement.

                                    Location   { numeric }  { required }  { no default: }

                                                Location is any numeric expression giving the location of NewStatement within the script.

                                    TextSize   { numeric }  { required }  { no default: }

                                                TextSize is any numeric expression giving the length of NewStatement's text in characters.

Comments:            The function returns "0" if successful and a non-0 value if it fails. AddOptional is disabled in the run-time version of VTS; it will do nothing and returns Invalid.

See Also:

AddVariable | GetStatement