Parameter list for exit routines

The parameter list for an exit routine contains pointers to other information, which generally includes the EXPL parameter list and the exit-specific parameter list.

Begin program-specific programming interface information.

The parameter list for the log capture exit routine consists of two 64-bit pointers. The parameter list for all other exit routines consists of two 31-bit pointers. Register 1 points to the address of parameter list EXPL, described by macro DSNDEXPL. The field that follows points to a second parameter list, which differs for each type of exit routine.

Figure 1. Use of register 1 on invoking an exit routine. (Field procedures and translate procedures do not use the standard exit-specific parameter list.)
Begin figure description. Use of register 1 on invoking an exit routine. End figure description.

The following is a list of the EXPL parameters. Its description is given by macro DSNDEXPL:

Table 1. Contents of EXPL parameter list
Name Hex offset Data type Description
EXPLWA 0 Address Address of a work area to be used by the routine
EXPLWL 4 Signed 4-byte integer Length of the work area. The value is:
  • 2048 for connection routines and sign-on routines
  • 512 for date and time routines and translate procedures (see Note 1).
  • 256 for edit, validation, and log capture routines
EXPLRSV1 8 Signed 2-byte integer Reserved
EXPLRC1 A Signed 2-byte integer Return code
EXPLRC2 C Signed 4-byte integer Reason code
EXPLARC 10 Signed 4-byte integer Used only by connection routines and sign-on routines
EXPLSSNM 14 Character, 8 bytes Used only by connection routines and sign-on routines
EXPLCONN 1C Character, 8 bytes Used only by connection routines and sign-on routines
EXPLTYPE 24 Character, 8 bytes Used only by connection routines and sign-on routines
EXPLSITE 2C Character, 16 bytes For SNA protocols, this is the location name of the requesting location or <luname>. For TCP/IP protocols, this is the dotted decimal IP address of the requester. If the value of EXPLSITE_OFF is not 0, EXPLSITE is not used.
EXPLLUNM 3C Character, 8 bytes For SNA protocols, the locally known LU name of the requesting location. For TCP/IP protocols, the character string 'TCPIP'.
EXPLNTID 44 Character, 17 bytes For SNA protocols, the fully qualified network name of the requesting location. For TCP/IP protocols, field reserved.
EXPLVIDS 55 Character, 1 byte Db2 version identifier
EXPLSITE_OFF 56 Signed 2-byte integer Offset from the beginning of the work area to the extended location name of the Db2 site that originated the work request. Use this value if the location name is greater than 16 bytes. The extended location name has the following format:
  • Signed, 2-byte integer: Length of the extended location name
  • Character, 128 bytes: Extended location name
Notes: When translating a string of type PC MIXED, a translation procedure has a work area of 256 bytes plus the length attribute of the string.
End program-specific programming interface information.