Throughout this book, the syntax for each command is presented
in the form of a diagram. The diagram tells you what you can put between
the EXEC CICS® that begins a
command and the terminator that ends it. It summarizes what you can
do with the particular command, and indicates relationships between
different options and, sometimes, different values of an option.
Note:
The diagrams and some of the examples omit the initial
EXEC CICS and the language-dependent
terminator, even though you must use them in your code. The diagrams
also omit options that you can use in any command:
- NOHANDLE
- RESP
- RESP2
- SYSEIB
These have the same meaning in SPI commands as in API commands.
(See the CICS Application Programming Guide for basic information
about these options, and Exception conditions for additional SPI
details.)
You read the diagram by following the arrows from left to right,
using these conventions:
Symbol |
Action |
 >>-+-A-+-------------------------------------------------------><
+-B-+
'-C-'
|
A set of alternatives--one of which you must code. |
 .-------.
V |
>>---+-A-+-+---------------------------------------------------><
+-B-+
'-C-'
|
A set of alternatives--one of which you must code. You may code
more than one of them, in any sequence. |
 >>-+---+-------------------------------------------------------><
+-A-+
+-B-+
'-C-'
|
A set of alternatives--one of which you may code. |
 .-------.
V |
>>---+---+-+---------------------------------------------------><
+-A-+
+-B-+
'-C-'
|
A set of alternatives -- any number (including
none) of which you may code once, in any sequence. |
 .-A-.
>>-+---+-------------------------------------------------------><
'-B-'
|
Alternatives where A is
the default. |
 >>-| Name |----------------------------------------------------><
Name:
|--A-+---+------------------------------------------------------|
'-B-'
|
Use with the named section in place of its name. |
Punctuation and uppercase characters |
Code exactly as shown. |
Lowercase characters |
Code your own text, as appropriate (for example, name). |
Below is an example. It indicates that INQUIRE STORAGE requires
you to specify either the ADDRESS option or the NUMELEMENTS option
(but not both). If, and only if, you choose ADDRESS, you can specify
ELEMENT, FLENGTH, both, or neither. If you choose NUMELEMENTS, you
can specify DSANAME, ELEMENTLIST,
LENGTHLIST, or TASK in any combination (including none).

INQUIRE STORAGE
>>-INQUIRE STORAGE---------------------------------------------->
>--+-ADDRESS(ptr-value)--+-------------+--+-------------+-+----><
| '-| Element |-' '-| Flength |-' |
'-| nlist |--| elist |--| llist |--| task |------------'
Element:
|--ELEMENT(ptr-ref)---------------------------------------------|
Flength:
|--FLENGTH(data-area)-------------------------------------------|
nlist:
|--NUMELEMENTS(data-area)---------------------------------------|
elist:
|--+----------------------+-------------------------------------|
'-ELEMENTLIST(ptr-ref)-'
llist:
|--+---------------------+--------------------------------------|
'-LENGTHLIST(ptr-ref)-'
task:
|--+------------------+-----------------------------------------|
'-TASK(data-value)-'
Conditions: NOTAUTH, TASKIDERR
A list of the exception conditions that can occur on the command
appears at the bottom of the diagram. In this case, the possibilities
are the NOTAUTH and TASKIDERR conditions.
Here is a summary of the format rules for coding CICS commands:
- Follow the conventions of the language in which you are coding
for general format (the column in which the command starts, the columns
available to it, embedded comments, embedded blanks, and so on).
Note:
The translator is not sensitive to blanks between option
names and option values or the parentheses that separate them, so
you can use them or not, as you wish, even in assembler.
- Start your command with EXEC CICS or EXECUTE CICS and end it with the terminator
required by the program language (see Command format).
- If a command does not fit on a line, or you wish to break it into
multiple lines, use the conventions of the language. In assembler,
use a continuation character on all but the last line.
- Select the options you wish to use from the syntax diagram, observing
the rules expressed in the diagram and the option text for required
options and consistent combinations.
- Code punctuation and upper case letters as shown in the diagram
(you can use mixed case or lowercase for keywords shown in uppercase
if you prefer).
- Substitute your own text for lowercase letters, following the
conventions of the language in which you are coding.
[[ Contents Previous Page | Next Page Index ]]