Use the IKJRSVWD
macro instruction to do the following:
- Define a positional reserved word operand.
In this case, use
the IKJRSVWD macro instruction by itself and specify at least the ‘parameter-type’
operand.
- Describe the operator portion of an expression.
In this case,
use the RSVWD operand of the IKJOPER macro instruction to define the beginning
of a list of the possible reserved words that can be an operator in
an expression. To identify the possible reserved words that can be
operators in an expression, specify a list of IKJNAME macro instructions that immediately
follow the IKJRSVWD macro instruction.
You must specify at least the ‘parameter-type’
operand on the IKJRSVWD macro instruction.
- Describe a reserved word constant.
In this case, use the RSVWD
keyword of the IKJTERM macro instruction to define the beginning of a list
of possible reserved words that can be used as a figurative constant.
To define the possible figurative constants, specify a list of IKJNAME
macros that immediately follow the IKJRSVWD macro instruction.
When you use
the IKJRSVWD macro instruction to define a reserved word constant, code the macro
without any operands as follows:
The order in which you code the macros for positional operands
is the order in which the Parse Service Routine expects to find the operands in
the command string.
Figure 1 shows the format of the IKJRSVWD macro instruction.
Each of the operands is explained following the figure.
Figure 1. The IKJRSVWD macro instruction label IKJRSVWD 'parameter-type' [,PROMPT='prompt data' ]
[,DEFAULT='default value']
[,HELP=('help data','help data',…)]
- label
- This name is used to address the PCE built by the IKJRSVWD macro.
The hexadecimal offset to the parameter descriptor entry (PDE) built
by the Parse Service Routine for this operand is contained in the PCE.
Code the following operands on the IKJRSVWD macro when you use
it either by itself to describe a positional reserved word operand,
or with IKJOPER to describe the operator portion of an expression.
- ‘parameter-type’
- This field is required so that the operand can be identified
when an error message is necessary. This field differs from the PROMPT
field in that the PROMPT field is not required and if supplied is
used only for a required operand that is not entered by the terminal
user. Blanks within the apostrophes are allowed.
- PROMPT=‘prompt data’
- The operand described by this IKJRSVWD macro instruction is required. The
prompting data that you specify is issued as a message if the operand
is not entered by the terminal user. If prompting is necessary and
the terminal is in prompt mode, parse adds a message-identifying number
(message ID) and the word ENTER to the beginning of the message before
writing it to the terminal. If prompting is necessary but the terminal
is in no-prompt mode, parse adds a message ID and the word MISSING
to the beginning of the message before writing it to the terminal.
- DEFAULT=‘default value’
- The operand described by this IKJRSVWD macro instruction is required, but
the terminal user need not enter it. If the operand is not entered,
the value specified as the default value is used.
Note: If
neither PROMPT nor DEFAULT is specified, the operand is optional.
The Parse Service Routine takes no action if the operand is not present.
- HELP=(‘help data’,‘help data’,…)
- You can provide up to 255 second-level messages. (Note, however,
that the assembler in use can limit the number of characters that
a macro operand with a sublist can contain.) Enclose each message
in apostrophes and separate the messages by single commas. These
messages are issued one at a time after each question mark entered
by the terminal user in response to a prompting message from the parse
routine.
The Parse Service Routine adds a message ID and the word ENTER (in prompt
mode) or MISSING (in no-prompt mode) to the beginning of each message
before writing it to the terminal.