Introduction › Format

Format

The following information is presented for each item described in this book:

• On the left is the name of the verb or built-in. To the right of the name are the permissible operands for that verb or built-in.
• Each item contains some or all of the following section headings:

  Operands

  Description of operands.

  Return Codes

  Return code options set on completion of the item, with an explanation.

  Examples

  Examples of interface syntax.

  Notes

  Additional information about the item.

Example: Format

&INTCLEAR [ TYPE={ ALL | REQ | RESP | ANY } ]

UPPERCASE characters

Must be entered as shown for verb or built-in names or operands consisting of uppercase characters, but can be entered in uppercase or lowercase.

Italic characters

Are variables that show the kind of information, rather than the exact information that must be supplied. The actual entry replaces the italic description. Valid types of data are described for each verb or built-in within the operands section.

Underscored values

Indicate the defaulted value that is assumed for an operand if it is not specified in the verb or built-in.

{Braces}

Indicate the available options for an operand. One of the alternatives must be selected. Do not include the braces when entering a specification.

[Square brackets]

Indicate optional specifications. Do not include square brackets when entering a specification.

Or signs ( | )

Separate options for an optional or mandatory specification. If a group of options is enclosed by square brackets, and each is separated by an or sign, none of the options have to be chosen. If none are coded, the default value (underscored) is used.

Commas (,) and Equal (=) signs

Must be entered as shown. If commas or equal signs appear in brackets, they are optional and used only if the accompanying optional operand is used.

Ellipsis (…)

Denotes items that are repeated.