INCLUDE command

From m204wiki
Jump to: navigation, search

Summary

Privileges
Any user
Function
Executes a procedure

Syntax

INCLUDE [procnumber | procname] [delimiter response [delimiter response]...]

Where:

procnumber The number of an existing temporary procedure; it can be zero or a negative number.
procname The name of an existing procedure.
delimiter One of the following characters:
Character name Keyboard display
Blank
Comma ( , )
Equal sign ( = )
Left parenthesis ( ( )
Right parenthesis ( ) )
response A dummy string or $READ function response. Any number of responses can be specified on a command line, separated by delimiters. If dummy string and $READ responses are specified on the same command line, dummy string responses must appear first.

Example

INCLUDE INCLUDE ACCOUNT, OK, NA, DK

Usage notes

  • The INCLUDE command unconditionally executes a procedure or a recent SOUL request. (The IF command conditionally executes a procedure.)
  • When a procedure is included, each command in the procedure is executed. If any statements follow a BEGIN or MORE command in the procedure, they are compiled. When an End statement is encountered in the procedure, Model 204 runs the request that precedes the End.

    If the request that follows a BEGIN or MORE command has no End statement and concludes the procedure, the request is compiled through the last statement in the procedure, but the request is not run. You can continue entering the request at this point, and then run the request. However, the statements entered at this time are added to the procedure only if it is temporary procedure 0. If the procedure has a name or a nonzero number, it is not altered. This is shown in the example that follows.

    Suppose that temporary procedure -3 continues a SOUL request, but it has no End statement. When the user enters:

    INCLUDE -3

    Model 204 retrieves temporary procedure -3 and compiles it, but cannot execute it. The user can now continue entering the request. The request remains temporary procedure -3; it does not become temporary procedure 0 (the current procedure). When the user enters End, the request is run. However, the stored temporary procedure -3 is not altered. The new statements are not added to the procedure. The procedure can be changed only by reentering the entire request or by invoking the Editor.

  • The SOUL INCLUDE statement is available for inserting procedures into SOUL requests. As dummy strings and $READ functions are encountered in the procedure, responses are retrieved, one by one, from the INCLUDE command line.
  • When multiple procedure files are defined in a CREATE GROUP command, the INCLUDE command searches the files in sequence, starting with the first file and ending with the last file defined. The settings of the PRIVDEF parameter do not affect the search order.