Exit XDTLC

The XDTLC user exit is invoked at the completion of data table loading—whether successful or not. The user exit is not invoked if the data table is closed for any reason before loading is complete. The XDTLC exit is invoked for a coupling facility data table only if the table is loaded from a source data set.

The exit program is informed if the loading did not complete successfully—see field UEPDTORC. This could occur, for example, if the maximum number of records was reached or there was insufficient virtual storage. In this case, the exit program can request that the file is closed immediately, by setting the return code. Depending on the return code value, the action taken by CICS® can be found in Return codes for XDTLC user exit.

All XPI calls can be used with the XDTLC exit, and no API or SPI calls can be used.

Exit-specific parameters for XDTLC user exit

  • UEPDTPL: The 8-character data table name
  • UEPDTFLG: A 1-byte flag field. The possible bit settings are:
    • UEPDTSDT (X'80'): The exit has been invoked by CICS shared data table support.
    • UEPDTCMT (X'40'): This is a CICS-maintained shared data table. Only meaningful if UEPDTSDT is on.
    • UEPDTCFT(X'10'): The exit has been invoked by coupling facility data table support.
    • UEPDTUMT (X'08'): This is a user-maintained shared data table. Only meaningful if UEPDTSDT is on.
  • UEPDTORC: Data table open result code. The possible values are:
    • UEPDTLCS: The load was successful.
    • UEPDTLFL: The load was unsuccessful.
  • UEPDTDSL: The fullword length of the name of the source data set. Only meaningful if either UEPDTSDT or UEPDTCFT is on.
  • UEPDTDSN: A 44-character field containing the name of the source data set. Only meaningful if either UEPDTSDT or UEPDTCFT is on.

Return codes for XDTLC user exit

A value of UERCPURG should be returned if the exit program has received a PURGED response to a call that it has issued.
  • UERCDTOK: No action; the file remains open. This is the default if the exit is not activated.
  • UERCDTCL: Close the file.