Previous Topic: User Exit 5

Next Topic: User Exit 7


User Exit 6

Purpose

This exit point allows execution of a user‑developed exit routine when certain key points are reached in the progress of a CA XCOM Data Transport transfer.

Conditions of Entrance

This user exit is entered under the following conditions:

Defined Exit States

The following states are defined for this exit:

QUEUED

Transfer has been scheduled or a request from a remote system has been received

NULL

Transfer is not yet scheduled

INACT

Transfer is scheduled but is waiting

ACTIVE

Transfer is currently in progress

SUSPEND

Transfer has been suspended on the local system

REMSUSP

Transfer has been suspended by the remote system

SUCCESS

Transfer has completed successfully

FAILED

Transfer has failed

VTAM ER

Transfer received a VTAM error and will be retried

Module Name and Entry Point

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

How to Enable

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

Calling Module

The module XCOMEXIT calls this exit.

Entry Method

This exit is a branch entry.

Required DSECT

EX06PLST 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 EX06PLST

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.

Note: The return code from the exit is passed in field EX06RC of the exit parameter list (which is mapped by the EX06PLST macro found in CAI.CBXGMAC).

Sample Program

The following is a sample program using this exit:

CAI.CBXGSAMP(XCOMEX06)