Macro type: type S (E form/L form/D form/C form); see "Macro types"
The ADDPLNK macro is used to assign a pool link name to an ISAM pool for a user job and to enter this name in a pool table. This pool
link name must have been entered in the task file table by means of the FILE command (operands LINK and POOLLNK) or specified in the FCB (field POOLLNK). During OPEN processing, the system checks whether a pool link name exists for the file and whether an ISAM pool exists for the name.
Format
Operation | Operands |
|
|
| |
| |
|
Operand descriptions
CATID = catid
Specifies the pubset to which the ISAM pool belongs. This must match the “catid” specification in the CREPOOL macro.
Default value: | the default catalog ID of the task. |
LINKNME = name
allocates the pool link name “name” to the ISAM pool “poolname”. “name” can consist of 1-8 characters; character set allowed: all letters and digits as well as the special characters $, # and @, with the first character not being a digit or $.
MACID
Evaluated only in conjunction with MF=C; defines the second through fourth characters of the field names and equates generated in the data area when the macro is expanded.
Default value: | MACID = ISA |
= macid
Three-character string defining the second through fourth characters of each field name and equate generated.
MF
The forms of the MF operand are described in detail in the appendix ("Macro types").
PARAM
Specifies the address of the operand list; evaluated only in conjunction with MF=E (see "Macro types").
= addr
Symbolic address (name) of the operand list.
= (r)
Number of the register containing the address of the operand list. The register must be loaded with this address value before the macro is called.
POOLNME = poolname
Specifies the ISAM pool to be used for file processing. “poolname” is the name with which the ISAM pool was created (see the CREPOOL macro, "CREPOOL - Create ISAM pool").
PREFIX
evaluated only in conjunction with MF=C or MF=D; defines the first character of each field name and equate generated in the data area when the macro is expanded.
Default value: | PREFIX = D |
= pre
One-character prefix with which the field names and equates generated by the assembler are to begin.
SCOPE
Specifies the scope of the ISAM pool. This must have the same value as in the CREPOOL macro.
= TASK
The pool link name is assigned to the task-local ISAM pool “poolname”.
= USERID
This scope is still supported only for reasons of compatibility (see the CREPOOL macro, "CREPOOL - Create ISAM pool").
= USERGROUP
This scope is still supported only for reasons of compatibility (see the CREPOOL macro, "CREPOOL - Create ISAM pool").
= HOST
The pool link name is assigned to the cross-task ISAM pool “poolname”.
Return codes
Unless otherwise specified, the field names and EQU statements for return codes generated by the C and D forms of the macro begin with the string DISA; this string can be modified by means of PREFIX and MACID.
The return codes are kept in the default header of the operand list.
Main return code | Meaning |
DISAOK X'0000' | The macro call was successful |
DISANPAR X'0001' | Access to the operand list was not possible |
DISANCAT X'0003' | The catalog ID “catid” is unknown in the system |
DISANACC X'0004' | There is no connection to pubset “catid” |
DISAINVN X'0005' | The pool name or pool link name is invalid |
DISANCLA X'000A' | The pool name already exists and the existing assignment cannot be cleared |
DISASYSE X'000B' | An internal error occurred during macro processing |
DISANOPL X'000D' | There is no pool with the specified name |
DISARLNK X'FFFF' | The macro call could not be executed: evaluate subsidiary return code 1 (linkage error) |