User Exits › User Exit 10

User Exit 10

Purpose

This exit point allows execution of a user‑developed exit routine that generates a user‑designed banner page for all reports received by the system.

Module Name and Entry Point

The default module name and entry point for this exit is XCOMEX10. The default module name can be overridden by specifying the load-module name in the Default Options.

How to Enable

Specify EXIT10=YES | Load-module name in the Default Options to enable this exit.

Calling Module

The modules XCOMRECV, XCOMUPL2, XCOMUPL6, and XCOMUP2F call this exit.

Entry Method

This exit is a branch entry.

Required DSECT

There is no required DSECT.

Addressing Mode at Entry

The addressing mode at entry is 31.

Registers at Entry

The following registers are available at entry:

R0 ‑ R2

Undefined

R3

Address of NSA control block (mapped by NSADSECT macro)

R4

Number of lines in each banner

R5

Number of letters per line

R6

Number of characters per letter

R7

Address of banner field

R8

Address of file data field

R9 to R12

Undefined

R13

Address of CSA control block (mapped by CSADSECT macro)

R14

Return address

R15

Entry point address

Registers at Exit

The following registers are available at exit:

R0 to R14

Undefined

R15

Return code

Valid Return Code

The only valid return code is 0 for a normal return.

Sample Program

The following is a sample program using this exit:

CAI.CBXGSAMP(XCOMEX10)