IBM SC34-6814-04 User Manual

Page 99

Advertising
background image

UEP_FC_SEQUENTIAL_WRITE

Records are to be written in sequential mode.

UEP_FC_DIRECT_WRITE

Records are to be written in direct mode.

UEP_FC_READ_INTEGRITY

Address of a byte containing (for non-update READ, READ NEXT,
and READ PREV requests) the read integrity setting. (In current
versions of CICS, this setting applies only to VSAM RLS.) On input
to the exit, this parameter will be set to one of:

UEP_FC_CR

Consistent read integrity is to be used.

UEP_FC_FCT_VALUE

Read integrity is according to the setting in the FILE
definition.

UEP_FC_NRI

The record is to be read with no read integrity.

UEP_FC_RR

Repeatable read integrity is to be used.

UEP_FC_TOKEN

Address of a fullword containing the value of TOKEN.

If the request is READ, READ NEXT, or READ PREV with update,
and the address is not null, the area is an output field in which the
token is to be returned.

If the request is REWRITE, DELETE without RIDFLD, or UNLOCK,
the area is an input field.

UEP_FC_SYSID

Address of a 4-byte area that is to contain the SYSID identifying the
remote region. On input to the exit, the area contains either:
v

The value of the SYSID option of the API call, or

v

Blanks (if SYSID was not specified).

To redirect the request to a different region, the exit program must
place the SYSID of the target region in this output area.

If this parameter is set by the exit program, the request is
function-shipped by file control without any reference to the file’s
attributes. If the key length has not been included on the request,
the exit program must establish its value by setting the
UEP_FC_RECORD_ID_L parameter.

Similarly, if the request is WRITE or REWRITE, and the record
length has not been specified on the request, the exit program must
establish its value by setting the UEP_FC_RECORD_L parameter.

UEP_FC_LENGTH_ERROR_CODE

Address of a 1-byte output area containing the length error code to
be returned after a request has completed. The possible values are:
v

UEP_FC_LENGTH_OK

v

UEP_FC_BUFFER_LEN_TOO_SMALL

v

UEP_FC_RECORD_LEN_TOO_LARGE

v

UEP_FC_BUFFER_LEN_NOT_FILE_LEN

v

UEP_FC_RECORD_LEN_NOT_FILE_LEN

Chapter 1. Global user exit programs

77

Advertising