Command: |
-* |
---|---|
Syntax: |
-* text where:
|
Function: |
The command -* signals the beginning of a comment line. Any number of comment lines follows one another, but each must begin with -*. A comment line may be placed at the beginning or end of a procedure, or in between commands. However, it cannot be on the same line as a command. Use comment lines liberally to document a stored procedure so that its purpose and history are clear to others. |
Command: |
-? |
---|---|
Syntax: |
-? &[string] where:
|
Function: |
The command -? displays the current value of a local variable. |
Command: |
-CLOSE |
---|---|
Syntax: |
-CLOSE filename where:
|
Function: |
-CLOSE closes an external file opened with the -READ or -WRITE NOCLOSE option. The NOCLOSE option keeps a file open until the -READ or -WRITE operation is complete. The external file must be defined to the operating system. |
Command: |
-AS/400 |
---|---|
Syntax: |
-AS/400 command where:
|
Function: |
-AS/400 executes an IBM i operating system command from a procedure. Ignored on all other operating systems. |
Command: |
-CMS |
---|---|
Syntax: |
-CMS command where:
|
Function: |
-CMS executes a CMS operating system command from a procedure. Ignored on all other operating systems. |
Command: |
-DEFAULTS |
---|---|
Syntax: |
-DEFAULTS &[&]name=value [...] where:
|
Function: |
-DEFAULTS supplies an initial (default) value for a variable that had no value before the command was processed. Override values set with -DEFAULTS by supplying new values:
By supplying values to variables in a stored procedure, -DEFAULTS helps ensure that it runs correctly. |
Command: |
-DOS |
---|---|
Syntax: |
-DOS command where:
|
Function: |
-DOS executes a Windows or DOS operating system command from a procedure. Ignored on all other operating systems. |
Command: |
-EXIT |
---|---|
Syntax: |
-EXIT |
Function: |
-EXIT forces a stored procedure to end. All stacked commands are executed and the stored procedure exits (if the stored procedure was called by another one, the calling procedure continues processing). Use -EXIT for terminating a stored procedure after processing a final branch that completes the desired task. The last line of a stored procedure is an implicit -EXIT. In other words, the procedure ends after the last line is read. |
Command: |
-GOTO |
---|---|
Syntax: |
-GOTO label . . . -label [TYPE text] where:
|
Function: |
-GOTO forces an unconditional branch to the specified label. If Dialogue Manager finds the label, processing continues with the line following it. If Dialogue Manager does not find the label, processing ends and a message is displayed. |
Command: |
-IF |
---|---|
Syntax: |
-IF expression [THEN] GOTO label1[;] -[ELSE GOTO label2 [;]] -[ELSE IF...[;]] where:
|
Function: |
-IF routes execution of a stored procedure based on the evaluation of the specified expression. A -IF without an explicitly specified ELSE whose expression is false continues processing with the line immediately following it. |
Command: |
-INCLUDE |
---|---|
Syntax: |
-INCLUDE filename where:
|
Function: |
-INCLUDE enables one stored procedure to call another one. A stored procedure calls any number of other procedures. Up to four -INCLUDE commands are nested. The called procedure contains fully executable or partial code. The calling procedure cannot branch to a label in the called procedure and vice versa. |
Command: |
-label |
---|---|
Syntax: |
-label [TYPE message] where:
|
Function: |
A label is the target of a -GOTO or -IF command. |
Command: |
-PASS |
---|---|
Syntax: |
-PASS password where:
|
Function: |
Directly issues and controls passwords. This feature is especially useful for specifying a particular file or set of files that a given user can read or write. Passwords have detailed sets of functions associated with them through the DBA module. Procedures that set passwords should be encrypted so that it and the passwords that it sets cannot be typed and made known. A variable can be associated with -PASS so that you can prompt for and assign a password value using -PROMPT. The PASS command provides the same function at the command level, as does the PASS parameter of the SET command. |
Command: |
-PROMPT |
---|---|
Syntax: |
-PROMPT &name [[.format|.(list)] [.text].] where:
|
Function: |
Types a message to the terminal (if edastart -t is in use) or creates an input window with the message in a browser if the connection type is HTTP and reads the reply from the user. This reply assigns a value to the variable named. In edastart -t mode, if a format is specified and the supplied value does not conform, FOCUS displays a message and prompts the user again for the value. In HTTP mode, only a message is displayed. In edastart -t mode, if a (list) is specified and the user does not reply with a value on the list, FOCUS reprompts and prints the list of acceptable values. For HTTP type connections, the list is interpreted as a pull-down list, so only a valid value may be selected. Note: You cannot use format and list together. |
Command: |
-QUIT |
---|---|
Syntax: |
-QUIT |
Function: |
-QUIT forces an immediate exit from a stored procedure. Stacked commands are not executed. In this respect, -QUIT is different from -EXIT, which executes stacked commands. If the procedure was called by another one, control returns directly to the client application, not to the calling procedure. -QUIT is the target of a branch. |
Command: |
-READ |
---|---|
Syntax: |
-READ filename[,] [NOCLOSE] &name[.format.][,]... where:
|
Function: |
-READ enables the reading of data from an external file that is defined to the operating system. The length of the variable list must be known before the -READ command is encountered. Use a -DEFAULTS command to establish the number of characters expected for each variable. If the list of variables is longer than one line, end the first line with a comma and begin the next line with a hyphen if you are reading a free-format file. -READ EXTFILE, &CITY, &CODE1, - &CODE2 If you are reading a fixed-format file, begin the next line with a hyphen and comma. -READ EXTFILE &CITY.A8. &CODE1.A3., -, &CODE2.A3. |
Command: |
-REMOTE |
---|---|
Syntax: |
-REMOTE [BEGIN|END] where:
|
Function: |
-REMOTE commands are the initial form of stored procedure routing, and are available with Hub Services only. Dialogue Manager commands within the delimiters are executed, and variable substitution takes place before the stack is sent to the target server. A -INCLUDE command takes a Dialogue Manager procedure residing on the originating server and includes the procedure commands in the stack. The commands within the delimiters must make up a complete server request. Any command valid on the target server is included. The command EXEC may be included within the delimiters to execute a stored procedure on the target server. -REMOTE commands cannot be nested. |
Command: |
-REPEAT |
---|---|
Syntax: |
-REPEAT labeln TIMES or -REPEAT label WHILE condition or -REPEAT label FOR &variable [FROM fromval] [TO toval] [STEP s] where:
|
Function: |
-REPEAT allows looping in a stored procedure. The parameters FROM, TO, and STEP appear in any order. A loop ends when:
|
Command: |
-RUN |
---|---|
Syntax: |
-RUN |
Function: |
-RUN causes immediate execution of all stacked commands. Following execution, processing of the stored procedure continues with the line that follows -RUN. -RUN is commonly used to:
|
Command: |
-SET |
---|---|
Syntax: |
-SET &[&]name=expression; where:
|
Function: |
-SET assigns a literal value to a variable, or a value that is computed in an arithmetic or logical expression. Single quotation marks around a literal value are optional unless it contains embedded blanks or commas, in which case the quotation marks must be included. |
Command: |
-TSO RUN |
---|---|
Syntax: |
-TSO RUN command where:
|
Function: |
-TSO executes a TSO operating system command from a procedure. Ignored on all other operating systems. |
Command: |
-TYPE |
---|---|
Syntax: |
-TYPE text where:
|
Function: |
-TYPE sends a message to a client application. Any number of -TYPE commands can follow one another but each must begin with -TYPE. Variables may be embedded in the message. The values currently assigned to each variable are displayed. |
Command: |
-UNIX |
---|---|
Syntax: |
-UNIX command where:
|
Function: |
-UNIX executes a UNIX operating system command from a procedure. Ignored on all other operating systems. |
Command: |
-VMS |
---|---|
Syntax: |
-VMS command where:
|
Function: |
-VMS executes a VMS operating system command from a procedure. Ignored on all other operating systems. |
Command: |
-WINNT |
---|---|
Syntax: |
-WINNT command where:
|
Function: |
-WINNT executes a Windows or DOS operating system command from a procedure. Ignored on all other operating systems. |
Command: |
-WRITE |
---|---|
Syntax: |
-WRITE filename [NOCLOSE] text where:
|
Function: |
-WRITE writes data to an external file. If the command continues over several lines, put a comma at the end of the line and a hyphen at the beginning of each succeeding line. Unless you specify the NOCLOSE option, an opened file is closed upon termination of the procedure with -RUN, -EXIT, or -QUIT. |
iWay Software |