The $GTBOID macro ascertains the bourse ID associated with an event item. $GTBOID can only be used in exit routine number 0, which is called by the auxiliary task under TSOS. The task also created the event item (ENAEI macro). The event item ID must be transferred to the exit routine in the EXCALL parameter list.
macro format and operands description
[label] $GTBOID |
MF=C / D / E / L [,PREFIX=prefix] [,PARAM=addr] |
MF
Defines the macro format.
=C
The parameter list is generated as a data area.
=D
The parameter list is generated as a DSECT with the name specified for “label”; default value: label = NTEG.
=E
The commands are generated.
=L
The parameter list is generated (without field names and equates).
PREFIX
Character for the field names in the parameter list. Only possible in conjunction with MF=C/D.
=prefix
Character with which the field names in the parameter list are to begin; default value: N.
PARAM
Address of the parameter list; only practical in conjunction with MF=E.
=addr
Address of the parameter list.
Notes
R12 and R13 must not have been modified since the exit routine was called.
R14, R15 and R1 are updated by MF=E.
The parameter list must be processed in line with reentrant programming.
Return code
The following return code is transferred in the parameter list’s standard header:
Main code | Meaning |
NTEGPAER | Parameter syntax error |
NTEGEIER | Incorrect event item ID; no bourse ID returned |
X' 00' | Successful call; bourse ID returned |
EXIT0000 @ENTR TYP=E,ENV=SPLSPEC,LOCAL=ADF
:
MVC CPARAM(NTEG#),LPARAM ——————————————————————————————————— (1)
MVC NTEGEIID(4),EIID ——————————————————————————————————————— (2)
$GTBOID MF=E,PARAM=CPARAM ———————————————————————————————————— (3)
CLI NTEGMR1,X'00' —————————————————————————————————————————— (4)
BNE exception
MVC BOID(4),NTEGBOID ——————————————————————————————————————— (5)
:
@EXIT
:
LPARAM $GTBOID MF=L ————————————————————————————————————————————————— (6)
NTEGDATA DS 0A
NTEGFHE DS 0XL8 GENERAL OPERAND LIST HEADER
NTEGFCTU DC AL2(81) FUNCTION UNIT NUMBER
NTEGFCT DC AL1(0) FUNCTION NUMBER
NTEGFCTV DC AL1(1) FUNCTION INTERFACE VERSION NUMBER
NTEGRET DC X'FFFFFFFF' RETURN CODE NOT VALID
NTEGMR1 EQU NTEGRET+3,1 MAIN RETURN CODE 1
*
NTEGEIID DC F'0' Event Item Identifier (EIID)
NTEGBOID DC F'0' Bourse Identifier (BOID)
NTEG# EQU *-NTEGDATA Size of Parameter List
:
BOID DC A(0)
ENTRY BOID
@END
ADF @PAR L=YES
:
CPARAM $GTBOID MF=C ————————————————————————————————————————————————— (7)
ADF @PAR LEND=YES
(1) | The current parameter list is preset with the default values. |
(2) | The event item ID is added. |
(3) | The function $GTBOID is called. |
(4) | The return code is evaluated. |
(5) | The bourse ID is stored in a clearly visible place or in the system vector if the operation is successful. |
(6) | Standard values for the parameter list. |
(7) | Dummy character of the current parameter list in automatic memory layout. |