Metasyntax for macro call formats

The following table explains the specific metacharacters and declarations that are used to represent formats of macro calls:

Formal notation	Explanation	Example
UPPERCASE LETTERS	Uppercase letters designate constants and must be entered by the user exactly as shown.	DATATYPE=CATID Required input: DATATYPE=CATID
Lowercase letters	Lowercase letters designate variables that must be replaced by the user with current values on input, i.e. they represent values that may differ from case to case.	SHORTST=integer Required input: SHORTST=10 or SHORTST=54 etc.
	Braces enclose multiple alternatives, i.e. one of the enclosed values must be selected.	Required input: CCSNAME=*NO or CCSNAME=*EXTEND or CCSNAME=xxxxx
/	A slash is used as a separator between two alternatives from which one must be selected	SYMTYP=CSECT/ENTRY Required input: SYMTYP=CSECT or SYMTYP=ENTRY
Underscoring	Underscoring is used to indicate the default value, i.e. the value assumed by the system if no entry is made by the user.	PATTERN=*NO / addr
. . .	Ellipses are used to indicate repetitions, i.e. the preceding unit may be repeated in succession more than once.	(module,...) Required input: (MODULE1) or (A,B,C) or (A1,A2,A3,A4) etc.
list-poss(n)	Means that a list can be constructed from the values that follow list-poss(n). If (n) is specified, the list may include a maxi-mum of n elements. If the list contains more than one element, it must be enclosed within parentheses.	DEVCLAS=list-poss(2): DISK / TAPE Required input: DEVCLAS=DISK or DEVCLAS=TAPE or DEVCLAS=(DISK,TAPE)
[ ]	Square brackets enclose optional entries, i.e. specifications that may be omitted. If a comma is included with an optional entry within the square brackets, it must be entered only if that optional entry is used and may be omitted for the first operand. If the comma is located outside the brackets, it must always be entered even if none of the optional entries are made (parentheses, if any, must always be specified).	MAP=S[YSOUT] Required input: MAP=SYSOUT or in abbreviated form: MAP=S
equals sign =	The equals sign (=) separates the operand from the operand value.	SPIN=*NO / *YES
< >	Angle brackets identify the data type of the operand.	INOUT=<var:pointer>

Table 4: Elements of metasyntax

Data types of operand values

Data type	Character set	Notes
c-string	EBCDIC characters	Must be enclosed within single quotes and specified without a leading “C”. Single quotes appearing in the string must be duplicated. The specification is followed by the meaning of its contents in SDF notation, separated by a colon. The suffix n..m defines the input length in bytes. Example: Shown in the syntax diagram as: SELECT=<c-string 1..255> Input: SELECT='testfile'
x-string	Hexadecimal 00..FF	Must be enclosed within single quotes and preceded by the letter X, i.e. in the form X ́xxxx ́. The suffix n..m defines the input length in bytes. Example: Shown in the syntax diagram as: PASSWORD=<x-string 1..10> Input in Assembler: PASSWORD=X'FF00AA1122' Input in C/C++: PASSWORD=0xFF00AA1122
name	A..Z, 0..9, $, #, @	Identifier. The appropriate format is given under the relevant operand description. Example: Shown in the syntax diagram as: PARAM=<name 1..8> Input: PARAM=MYPARAM
label	A..Z 0..9 $,#,@	Designates a label. Example: OUTAREA=structure (2): (1) address: <label>
integer	0..9,+,-	A “+” or “-” may only be the first character. The suffix n..m defines the permitted range of values. Example: Shown in the syntax diagram as: MAXLEN=<integer 1..255> Input: MAXLEN=200
var:		Introduces the specification of a variable. The data type of the variable is given after the colon (see following table). Example: Shown in the syntax diagram as: SELECT = <var: char:255> Input (to specify the variable name): SELECT=VARSELECT
reg:		Introduces a register specification (Register 0..15). The data type of the register contents is given after the colon. A register or register EQUATE may be used on input.

Data types of operand values

Data types of variables and register contents

Data type	Description
char:n	Designates a character string of length n. The string may be shorter, but only if a specific condition is satisfied. The applicable conditions are given under the respective operand descriptions. If the length is not specified, n=1 is assumed.
int:n	Designates an integer with a length of n bytes, where n<=4. If the length is not specified, n=1 is assumed.
bit:n	Designates a bit string of length n. If the length is not specified, n=1 is assumed. (in C: declaration as 'unsigned')
enum-of E:n	The variable is the enumeration E with a length of n bytes, where n<=4. If the length is not specified, n=1 is assumed.
pointer	Pointer (the address is passed). Area reference with the aid of pointer variables: with MF=L: address notation: ...,MF=M,<operand>=A(area) with MF=M: register notation, address notation or symbolic address of a field containing the address of an area: LA 2,area ... MF=M,<operand>=(2) or ... MF=M,<operand>=A(area) or LA 2,area ST 2,areaADD ... MF=M,<operand>=areaADD areaADD DS A

Data types of variables and register contents