User Exits › User Exit 9

User Exit 9

Purpose

This exit point allows execution of a user‑developed exit routine that creates and processes its own CA XCOM Data Transport commands. The exit is activated by means of the EXIT operator command (for example, F XCOM,EXIT,userdata). The supplied data, up to eight bytes, is then passed to the XCOMEX09 routine, where you can perform any pertinent processing. This exit can be used to control and alter the functionality of the other CA XCOM Data Transport exits.

Module Name and Entry Point

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

How to Enable

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

Calling Module

The module XCOMXFER calls this exit.

Entry Method

This exit is a branch entry.

Required DSECT

EX09PLST is the required DSECT.

Addressing Mode at Entry

The addressing mode at entry is 31.

Registers at Entry

The following registers are available at entry:

R0

Undefined

R1

Address of EX09PLST

R2 to R12

Undefined

R13

Address of register save area

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(XCOMEX09)