Exits for the TPF Component

This document describes the exits for the TPF component.

This document covers the following topics:


USERID exit

This exit is used to determine the node ID to be used to logon to the Com-plete target. It is invoked if EXIT is specified for the NODEID parameter in the TPFXTAB subtable, (USERDEF) in ACSTAB.

How to use the USERID exit

Entry is via standard linkage conventions.

Upon entry to the USERID exit, a set a parameters is received in the form of fullword addresses pointed to by R1.

All registers must be restored to their original values before control is returned from the exit to the calling program.

R1 The address of the parameter list.
R13 The address of an 18-fullword savearea.
R14 The return address.
R15 The entry point address of the exit.
Parameters

The first address is the address of a 40-fullword work area that can be used as working storage by the exit. It is recommended that the first 18-fullwords of this area be used as a savearea.

The second address is the address of the appropriate entry in the transparency subtable (TPFXTAB). The layout of this entry is defined in the DSECT in the copy book CCACSTAB.

The third address is the address of an 8-byte field where the exit should place the node ID to be used for communication with the target Com-plete system.

Linkage

Change the supplied linkage for TPFXF46 so that the pre-defined exit name TPFXNTCM is overridden by the name of your choice. Insert the following lines between the INCLUDE SYSLIB(TPFXCICS or TPFXTSO) and INCLUDE SYSLIB(TPFX01):

CHANGE userexit(TPFXNODE)
INCLUDE USERLIB(userexit)

The resulting linkage will return a condition code of 4.

NODEID exit

This exit is used to determine the node ID to be used to logon to the Com-plete target. It is invoked if EXIT is specified for the NODEID parameter in the TPFXTAB subtable, (USERDEF) in ACSTAB.

How to use the NODEID exit

Entry is via standard linkage conventions.

Upon entry to the NODEID exit, a set a parameters is received in the form of fullword addresses pointed to by R1.

All registers must be restored to their original values before control is returned from the exit to the calling program.

R1 The address of the parameter list.
R13 The address of an 18-fullword savearea.
R14 The return address.
R15 The entry point address of the exit.
Parameters

The first address is the address of a 40-fullword work area that can be used as working storage by the exit. It is recommended that the first 18-fullwords of this area be used as a savearea.

The second address is the address of the appropriate entry in the transparency subtable (TPFXTAB). The layout of this entry is defined in the DSECT in the copy book CCACSTAB.

The third address is the address of an 8-byte field where the exit should place the node ID to be used for communication with the target Com-plete system.

Linkage

Change the supplied linkage for TPFXF46 so that the pre-defined exit name TPFXNODE is overridden by the name of your choice. Insert the following lines between the INCLUDE SYSLIB(TPFXCICS or TPFXTSO) and INCLUDE SYSLIB(TPFX01):

CHANGE userexit(TPFXNODE)
INCLUDE USERLIB(userexit)

The resulting linkage will return a condition code of 4.

An example of TPFXNODE is delivered in the source library.

TPFXFEX exit

This exit is invoked after CICS/TPFXTSO has built the data to be passed to the ACCESS program.

How to use TPFXFEX exit

Entry is via standard linkage conventions.

Upon entry to TPFXFEX, a set a parameters is received in the form of fullword addresses pointed to by R1.

All registers must be restored to their original values before control is returned from the exit to the calling program.

R1 The address of the parameter list.
R13 The address of an 18-fullword savearea.
R14 The return address.
R15 The entry point address of the exit.
Parameters

The first address is the address of a 40-fullword work area that can be used as working storage by the exit. It is recommended that the first 18-fullwords of this area be used as a savearea.

The second address is the address of the appropriate entry in the transparency subtable (TPFXTAB). The layout of this entry is defined in the DSECT in the copy book CCACSTAB.

The third address is the address of the area which will be passed to the ACCESS program.

Linkage

Link the TPFXFEX exit with CICS/TPFXTSO directly. Insert the following line after the INCLUDE SYSLIB(TPFXF01):

INCLUDE USERLIB(TPFXFEX)

Exits in ACCESS46

Please refer to the description of the ACCESS exits ACSUUEX1 and ACSUUEX2 in the Com-plete System Programming documentation.