In the ISPF configuration
table keyword file, this exit is set with keywords MEMBER_LIST_LINE_COMMAND_PROGRAM_EXIT
and MEMBER_LIST_LINE_COMMAND_COMMAND_EXIT.
The member list
line command exit enables installations to change or restrict the
behavior of the built-in line commands entered in a PDF member list.
This exit is invoked for single-character member list built-in line
commands invoked from ISPF option 3.1, ISPF option 3.4, and the ISPF
Workplace (option 11).
This exit can be used to modify the
behavior of built-in line commands. For example, when the E (edit)
command is entered next to a member, the exit might examine the contents
of the member and invoke a program other than the ISPF editor to process
that member. If the exit then determines that the ISPF editor does
not need to be invoked, it must return a return code of 8.
Exit parameters
PDF uses these parameters
to communicate with the line command exit routine. These parameters
are passed as a single 65-character string. A single blank is placed
between parameters.
Table 1. Details of the parameters used to communicate with the line
command exit routineParameter |
Type |
Len |
Description |
Modifiable |
---|
LINE COMMAND |
CHAR |
1 |
A 1-character field containing the data set list
line command. |
No |
DATA SET NAME AND MEMBER |
CHAR |
56 |
A 56-character field containing data set name
and member against which the line command is run. The format of this
field is: 'DATA.SET.NAME(MEMBER)'. The field is left-justified with
trailing blanks. |
No |
VOLUME SERIAL |
CHAR |
6 |
A 6-character field containing the volume on which
the data set specified in DATA SET NAME AND MEMBER can be found. |
No |
Usage notes
- The name of the module is placed into the ISPF configuration table
when the product is installed.
- 31-bit addressing must be supported by the exit routine as it
is given control in AMODE 31. PDF does not restrict the RMODE of the
exit, but RMODE ANY is recommended.
- For the program version of the exit, standard OS linkage conventions
are used to branch to the exit routine that is defined.
- For the command version of the exit, the parameters are passed
as operands.
- You can make PDF service calls from within the exit routine.
- You cannot activate or deactivate the exit while a PDF session
is in progress. You can make changes to the exit routine load module
at any time, but because PDF loads the module only once at session
initialization, the changes are not recognized until the next ISPF
session.
- If the exit name has been specified in the ISPF configuration
table and the member list was generated from ISPF option 3.1, 3.4,
or 11, the exit is called before each built-in line command is processed.
The exit can analyze the line command and determine whether you should
invoke the command as entered, or not at all.
Error processing
If a nonzero return code
is returned from an exit call, a message is conditionally set.
Return codes
- 0
- Use line command as specified by the user
- 8
- Do not invoke this built-in command
- 20
- Severe error occurred.