General
Domain: | Job variables |
Macro type: | Type S (standard form/C/D/E/L form) |
In the C and D forms of the macro, a prefix (PREFIX = pre, where pre is 1..3 letters) can be specified (see section “The PREFIX operand”). | |
Default value: | PREFIX=IDJ |
Macro description
The LNKJV macro transfers information on the links between job variables and job variable link names (JV-LINK) from the JV-LINK table to a user area.
Macro call format and operand description
Operation | Operands |
|
|
area
Symbolic address of an area in the program to which the LNKJV information is to be transferred.
The area is supplied by LNKJV as follows:
|
|
|
|
|
|
|
| ||
<----------------------------------------> | ||||
The end of the listed LNKJV information is identified by means of one byte; this last byte contains the value X'00' if all the LNKJV information has been transferred to the user area. If the user area was unable to accommodate all entries, the last byte contains the value X'01'.
length
Explicit length of the user area.
If this operand is omitted, the implicit length of “area” is used. The user area must be at least 63 bytes long.
JVNAME=jvname
Fully or partially qualified path name of a permanent or temporary job variable whose link name is also to be placed in the defined area. The use of wildcards is allowed.
LINK=*jvlink
Valid link name of a job variable (as defined in DCLJV) whose complete path name is also to be placed in the defined area.
ODSECT=
Specifies whether an additional DSECT for the output of a single item of LNKJV information is to be generated. This entry only makes sense with MF=D.
NO
Default value; only one DSECT for the operand list of the LNKJV macro is generated.
YES
Generates an additional DSECT for the output of a single item of LNKJV information (for format, see “area” or DSECT).
VERSION=
Specifies which version of BS2000 the macro expansion is to be compatible with.
0
Default value; the macro expansion is compatible with JV <= V8.7.
1
The macro expansion is compatible with JV >= V10.0.
MF=
PREFIX=
For a description of the MF and PREFIX operands, see "The MF operand". Their permitted values are indicated at the beginning of the macro description and in the macro call format.
Notes concerning the DSECT
Calling the LNKJV macro with the operand MF=D generates a DSECT. When VERSION=1 is specified, the DSECT is generated with a standard header.
A DSECT is generated for the operand list of the LNKJV macro by default. If ODSECT=YES is specified, a DSECT is additionally generated for the output of an item of LNKJV information.
Return information and error flags
see chapter "Macro level".
DSECT
LNKJV LNKJV MF=D,VERSION=1,ODSECT=YES 1 *********************************************************************** 1 * VERSION 320 1 *********************************************************************** 1 * L N K J V P A R A M E T E R L I S T * 1 *********************************************************************** 1 #INTF REFTYPE=REQUEST, C 1 INTNAME=LNKJV,INTCOMP=001 1 LNKJV DSECT 1 *********************************************************************** 1 * UNIT=41, FUNCTION=7, VERSION=<PARAMETER VERSION> * 1 *********************************************************************** 1 FHDR MF=(C,IDJL) 2 DS 0A 2 IDJLFHE DS 0XL8 0 GENERAL PARAMETER AREA HEADER 2 * 2 IDJLIFID DS 0A 0 INTERFACE IDENTIFIER 2 IDJLFCTU DS AL2 0 FUNCTION UNIT NUMBER 2 * BIT 15 HEADER FLAG BIT, 2 * MUST BE RESET UNTIL FURTHER NOTICE 2 * BIT 14-12 UNUSED, MUST BE RESET 2 * BIT 11-0 REAL FUNCTION UNIT NUMBER 2 IDJLFCT DS AL1 2 FUNCTION NUMBER 2 IDJLFCTV DS AL1 3 FUNCTION INTERFACE VERSION NUMBER 2 * 2 IDJLRET DS 0A 4 GENERAL RETURN CODE 2 * 2 * GENERAL_RETURN_CODE CLEARED (X'00000000') MEANS 2 * REQUEST SUCCESSFUL PROCESSED AND NO ADDITIONAL INFORMATION 2 * 2 IDJLSRET DS 0AL2 4 SUB RETURN CODE 2 IDJLSR2 DS AL1 4 SUB RETURN CODE 2 2 * ALWAYS CLEARED (X'00') IF MAIN_RETURN_CODE IS X'FFFF' 2 * Standard subcode2 values as defined by convention: 2 IDJLR2OK EQU X'00' All correct, no additional info 2 IDJLR2NA EQU X'01' Successful, no action was necessary 2 IDJLR2WA EQU X'02' Warning, particular situation 2 IDJLSR1 DS AL1 5 SUB RETURN CODE 1 2 * 2 * GENERAL INDICATION OF ERROR CLASSES 2 * 2 * CLASS A X'00' FUNCTION WAS SUCCESSFULLY PROCESSED 2 * CLASS B X'01' - X'1F' PARAMETER SYNTAX ERROR 2 * CLASS C X'20' INTERNAL ERROR IN CALLED FUNCTION 2 * CLASS D X'40' - X'7F' NO CLASS SPECIFIC REACTION POSSIBLE 2 * CLASS E X'80' - X'82' WAIT AND RETRY 2 * 2 IDJLRFSP EQU X'00' FUNCTION SUCCESSFULLY PROCESSED 2 IDJLRPER EQU X'01' PARAMETER SYNTAX ERROR 2 * 3 GLOBALLY DEFINED ISL ERROR CODES IN CLASS X'01' - X'1F' 2 IDJLRFNS EQU X'01' CALLED FUNCTION NOT SUPPORTED 2 IDJLRFNA EQU X'02' CALLED FUNCTION NOT AVAILABLE 2 IDJLRVNA EQU X'03' INTERFACE VERSION NOT SUPPORTED 2 * 2 IDJLRAER EQU X'04' ALIGNMENT ERROR 2 IDJLRIER EQU X'20' INTERNAL ERROR 2 IDJLRCAR EQU X'40' CORRECT AND RETRY 2 * 2 GLOBALLY DEFINED ISL ERROR CODES IN CLASS X'40' - X'7F' 2 IDJLRECR EQU X'41' SUBSYSTEM (SS) MUST BE CREATED 2 * EXPLICITELY BY CREATE-SS 2 IDJLRECN EQU X'42' SS MUST BE EXPLICITELY CONNECTED 2 * 2 IDJLRWAR EQU X'80' WAIT FOR A SHORT TIME AND RETRY 2 IDJLRWLR EQU X'81' " LONG " 2 IDJLRWUR EQU X'82' WAIT TIME IS UNCALCULABLY LONG 2 * BUT RETRY IS POSSIBLE 2 * 2 GLOBALLY DEFINED ISL ERROR CODES IN CLASS X'80' - X'82' 2 IDJLRTNA EQU X'81' SS TEMPORARILY NOT AVAILABLE 2 IDJLRDH EQU X'82' SS IN DELETE / HOLD 2 * 2 IDJLMRET DS 0AL2 6 MAIN RETURN CODE 2 IDJLMR2 DS AL1 6 MAIN RETURN CODE 2 2 IDJLMR1 DS AL1 7 MAIN RETURN CODE 1 2 * 2 * SPECIAL LAYOUT OF LINKAGE_MAIN_RETURN_CODE (YYYY IN X'00XXYYYY') 2 * 2 IDJLRLNK EQU X'FFFF' LINKAGE ERROR / REQ. NOT PROCESSED 2 IDJLFHL EQU 8 8 GENERAL OPERAND LIST HEADER LENGTH 2 * 1 *********************************************************************** 1 * END OF STANDARD HEADER - START SPECIAL LNKJV PARAMETERLIST * 1 *********************************************************************** 1 IDJLHDRI EQU X'00290701',4 1 IDJLLINK DS CL8 LINKNAME 1 IDJLNAME DS CL80 JOBVARIABLE NAME 1 IDJLUNU2 DS CL20 UNUSED 1 IDJLADDR DS A AREA ADDRESS 1 IDJLSIZE DS H AREA SIZE 1 IDJLFLAG DS X INDICATOR 1 IDJLNOLI EQU X'80' LINK NOT SPECIFIED 1 IDJLNONA EQU X'10' JVNAME NOT SPECIFIED 1 IDJLECT EQU X'08' SET BY CMD PROCESSING 1 IDJLP2 EQU X'04' P2 CALLER 1 DS CL1 ALIGNMENT 1 IDJLJVS DS A RESERVED 1 IDJLPLLN EQU *-LNKJV 1 SPACE 1 *********************************************************************** 1 * L N K J V O U T P U T * 1 *********************************************************************** 1 IDJEL DSECT 1 IDJELLN DS C LAYOUT LENGTH 1 IDJELINK DS CL8 LINK NAME 1 IDJELJVN DS CL54 JV NAME (FULLY QUALIFIED) 1 IDJELLEN EQU *-IDJEL LENGTH OF MACRO 1 *********************************************************************** 1 SPACE