AddOptional
(Engine-Level Function)
| Description | Adds a new statement to an action script and returns its own error code. |
| Warning | This function should be used only by advanced programmers. |
| Returns | Numeric error code. |
| Usage | Script Only. |
| Function Groups | Compilation and Online Modifications, States |
| Related to: | AddVariable | GetStatement |
| Format | AddOptional(NewStatement, Destination, Location, TextSize) |
| Parameters |
| NewStatement |
| Required. Any expression that returns a statement value. This is the value of the new script statement to be added. |
| Destination |
| Required. Any code value expression. Destination is the action that will receive NewStatement. |
| Location |
| Required. Any numeric expression giving the location of NewStatement within the script. |
| TextSize |
| Required. Any numeric expression giving the length of NewStatement's text in characters. |
| Comments |
Seldom (if ever) used when adding features to modern VTScada applications. The function returns "0" if successful and a non-0 value if it fails. |