Exit xfcldel, file control logical delete exit – IBM SC33-1683-02 User Manual

Page 154

Advertising
background image

Exit XFCLDEL, file control logical delete exit

XFCLDEL is invoked whenever a WRITE to a VSAM ESDS, or to a BDAM data set,
is being backed out. Because these types of data set do not support deletion, you
can use XFCLDEL to perform a logical delete by amending the record in some way
that flags it as deleted.

When invoked

Invoked when backing out a WRITE to a VSAM ESDS or a BDAM data set.

Exit-specific parameters

UEPBLOGR

Address of the file control portion of the log record representing the
update that is to be backed out by logical deletion. The log record
can be mapped using the DSECT DFHFCLGD.

UEPTRANS

Address of the 4-byte transaction id under which the update that is
being backed out was made.

UEPTRMNL

Address of the 4-byte terminal id for the terminal or principal facility
from which the update that is being backed out was made.

UEPTASK

Address of the 4-byte (packed decimal) task number for the task
under which the update that is being backed out was made.

UEPFDATA

Address of a variable-length field containing the data in the file
control request. The exit program can amend the record data
addressed by this field, marking it in some way that applications
can recognize as representing a logically deleted record.

UEPFLEN

Address of a fullword containing the length of the data in the file
control request.

Return codes

UERCFAIL

Do not perform the logical delete, and treat this as a backout
failure. This is the default action taken if the exit is not enabled.

UERCLDEL

Perform the logical delete by reapplying the updated record.

A return code of UERCPURG is not allowed. There is no need to set a
UERCPURG return code, because the conditions under which this exit is
invoked should mean that “purged” cannot be returned by any XPI or API
calls.

XPI calls

All can be used, but subject to the same caution as for API and SPI calls.

API and SPI calls

Although this exit is allowed to issue API and SPI calls, you should be very
careful about which commands you use because the exit is invoked during
file backout, which is part of syncpoint phase 2.

file control recovery program exits

122

CICS TS for OS/390: CICS Customization Guide

Advertising