Syntax notation used for API comands in this book

In this book, the CICSPlex® SM API commands are presented in a standard way.

The EXEC CPSM that precedes the command name in the command-level interface is not shown, nor is the end-of-command delimiter. Likewise, the ADDRESS CPSM or var=EYUAPI() that is required for the REXX run-time interface is not shown.

You interpret the syntax diagrams shown in this book by following the arrows from left to right. The conventions are:

Symbol Meaning
Read syntax diagramSkip visual syntax diagram>>-+-A-+-------------------------------------------------------><
   +-B-+
   '-C-'
 
A set of mutually exclusive alternatives, one of which you must code.
Read syntax diagramSkip visual syntax diagram>>-+---+-------------------------------------------------------><
   +-A-+
   +-B-+
   '-C-'
 
A set of mutually exclusive alternatives, one of which you may code.
Read syntax diagramSkip visual syntax diagram   .-------.
   V       |
>>---+---+-+---------------------------------------------------><
     +-A-+
     +-B-+
     '-C-'
 
A set of alternatives, any number of which you may code.
Read syntax diagramSkip visual syntax diagram   .-A-.
>>-+---+-------------------------------------------------------><
   '-B-'
 
Alternatives where A is the default.
Read syntax diagramSkip visual syntax diagram>>-| Name |----------------------------------------------------><
 
Name:
 
|--A--+---+-----------------------------------------------------|
      '-B-'
 
See the separate syntax fragment whose name is shown.
Punctuation and uppercase characters Code exactly as shown.
Lowercase italics Code your own text, as appropriate (for example, name).

For example, with CONNECT VERSION(data-value) you must code CONNECT VERSION and () as they appear, but are free to code any four-character number that represents a valid release of CICSPlex SM.

[[ Contents Previous Page | Next Page Index ]]