NOT programming interface information
NOT programming interface information

ERB3XDRS data reduction exit routines

The exit routine specified in the exit_name parameter of the ERB3XDRS service is invoked on each system the ERB3XDRS request was directed to. The routine is assumed to have the following attributes:
Location:
JPA
State:
Problem
Key:
Any
Amode:
31
Rmode:
Any
Dispatchable unit mode:
Task
Address space control mode:
AR
Cross Memory Mode:
PASN=SASN=HASN
Serialization:
Enabled, unlocked
Type:
Reentrant, Refreshable

The exit is called by RMF™ as shown, with the parameters in the specified order.

Table 1. ERB3XDRS Exit Routine
Service call statement Parameters

CALL exit_name

(answer_area_addr
,answer_area_alet
,answer_area_length
,output_area_length
,input_data_address
,exit_parm
,exit_parm_length)

answer_area_addr
Specifies the address of the area to which the exit routine may return the selected information. The area resides in a data space owned by the RMF address space.

Answer_area_addr is defined as a pointer variable of length 4.

,answer_area_alet
Specifies the ALET of the answer area provided on the answer_area_addr parameter.

Answer_area_alet is defined as an unsigned integer variable of length 4.

,answer_area_length
Specifies the length of the answer area provided on the answer_area_addr parameter. RMF provides an answer area the same length as the answer area that the caller provided for ERB3XDRS, rounded to the next multiple of 4096. However, the data returned by the data reduction exit routine must fit into the answer area the caller provided for ERB3XDRS, including the common header and data headers created by RMF.

Answer_area_length is defined as an unsigned integer variable of length 4.

,output_area_length
Specifies the length of the data that is provided by the exit routine. If this value is larger than answer_area_length, a return and reason code is set, indicating that the length of the answer area is not sufficient.

Output_area_length is defined as an unsigned integer variable of length 4 and must be set by the exit routine.

,input_area_address
Specifies the address of the data reduction exit input data area. This data area contains the Monitor III control block XMHG3 at offset 0, followed by zero or more sets-of-samples, each of them starting with the Monitor III control block SSHG3.
Input_area_address is defined as a pointer variable of length 4. Control block XMHG3 has the following format:
This figure shows the format of the XMHG3 control block and is explained in the surrounding text.
ACR
(offset +00, length 5) Acronym of XMHG3, EBCDIC "XMHG3"
V
(offset +05, length 1) Version of XMHG3
DRC
(offset +08, length 4) Data return code. The possible codes are:
0
Successful data retrieval
4
Time out of range
8
Area too small
12
No data available
16
Severe error
DLN
(offset +12, length 4) Total data length including XMHG3 itself
FSS
(offset +16, length 4) Offset from XMHG3 to first set-of-samples header SSHG3
LSS
(offset +20, length 4) Offset from XMHG3 to last set-of-samples header SSHG3
FAV
(offset +40, length 8) Time in STCK format of first available data
LAV
(offset +48, length 8) Time in STCK format of last available data
,exit_parm
Specifies the parameter for the exit routine that has been provided by the caller of ERB3XDRS.

Exit_parm is defined as character variable of variable length.

,exit_parm_length
Specifies the length of the parameter string exit_parm that is passed to the exit routine.

Exit_parm_length is defined as unsigned integer variable of length 4.

End of NOT programming interface information
End of NOT programming interface information