Exit XFCFROUT

Exit XFCFROUT is invoked after the completion of a file control request.

Exit-specific parameters
UEPTRANID
Address of the 4-byte transaction ID.
UEPUSER
Address of the 8-byte user ID.
UEPTERM
Zero, or the address of the 4-byte terminal ID. If no address is returned, this could mean that this request has been function shipped over an IPIC connection.
UEPPROG
Address of the 8-byte application program name.
UEP_FC_FUNCTION
Address of a byte containing the function. The possible values are:
  • UEP_FC_FUN_READ_INTO
  • UEP_FC_FUN_READ_SET
  • UEP_FC_FUN_READ_UPDATE_INTO
  • UEP_FC_FUN_READ_UPDATE_SET
  • UEP_FC_FUN_WRITE
  • UEP_FC_FUN_REWRITE
  • UEP_FC_FUN_REWRITE_DELETE
  • UEP_FC_FUN_DELETE
  • UEP_FC_FUN_UNLOCK
  • UEP_FC_FUN_START_BROWSE
  • UEP_FC_FUN_READ_NEXT_INTO
  • UEP_FC_FUN_READ_NEXT_SET
  • UEP_FC_FUN_READ_PREVIOUS_INTO
  • UEP_FC_FUN_READ_PREVIOUS_SET
  • UEP_FC_FUN_READ_NEXT_UPDATE_INTO
  • UEP_FC_FUN_READ_NEXT_UPDATE_SET
  • UEP_FC_FUN_READ_PREVIOUS_UPDATE_INTO
  • UEP_FC_FUN_READ_PREVIOUS_UPDATE_SET
  • UEP_FC_FUN_RESET_BROWSE
  • UEP_FC_FUN_END_BROWSE
UEPTSTOK
Address of a 4-byte token that is valid throughout the life of a task. See Using the task token UEPTSTOK.
UEP_FC_FILE_NAME
Address of an 8-byte field containing the filename.
UEP_FC_BUFFER_P
Address of a fullword containing the address of the buffer provided by the originator of the request, in which the record is returned on completion of a READ, READ NEXT, or READ PREV request with the INTO option.
UEP_FC_BUFFER_L
Address of a fullword containing (for READ, READ NEXT, and READ PREV requests) the value of the LENGTH of the buffer into which the record was read.
UEP_FC_RECORD_P
Address of one of the following:
  • If the request is a READ, READ NEXT, or READ PREV request with the SET option, a fullword in which is returned the address of a buffer, into which the record was placed.
  • If the request is WRITE or REWRITE, a fullword containing the address of the record that was written.
UEP_FC_RECORD_L
Address of a fullword containing (for READ, WRITE, REWRITE, READ NEXT, and READ PREV requests) the value of LENGTH.

For all READ, READ NEXT, or READ PREV requests, this is an output field, containing the actual length of the record read. For these types of request, this record-length value is always present, even if the LENGTH option was not specified on the EXEC CICS API call.

For a WRITE or REWRITE, this is an optional field which, if present, contains the length of the record that was written.

UEP_FC_MAX_RECORD_L
Address of a fullword containing the maximum record length of the file.
UEP_FC_RECORD_ID_P
Address of a fullword containing the address of the value of RIDFLD (record identifier). For a discussion of when the record identifier is an input or an output field, see Table 1.
UEP_FC_RECORD_ID_L
Address of the halfword value of KEYLENGTH, which is the (possibly partial) length of the record identifier.

The length of the record identifier is an optional input parameter on READ, WRITE, DELETE, START BR, READ NEXT, READ PREV, and RESET BR requests.

UEP_FC_FULL_RECORD_ID_L
Address of the halfword value of the full length of the record identifier. (The full length of the record identifier corresponds to the KEYLENGTH keyword of the EXEC CICS interface.)

The full length of the record identifier is returned as a mandatory output field on READ NEXT and READ PREV requests.

UEP_FC_RECORD_ID_TYPE
Address of a byte containing (for READ, WRITE, DELETE, START BR, READ NEXT, READ PREV, and RESET BR requests) the RIDFLD type.
UEP_FC_KEY
VSAM KSDS or AIX® PATH access
UEP_FC_RBA
VSAM ESDS or KSDS via RBA access
UEP_FC_RRN
VSAM RRDS access
UEP_FC_DEBKEY
BDAM deblocking by key (READ, DELETE, START BR, and RESET BR requests only)
UEP_FC_DEBREC
BDAM deblocking by relative record (READ, DELETE, START BR, and RESET BR requests only)
UEP_FC_XRBA
VSAM extended ESDS access
UEP_FC_REQID
Address (for START BR, READ NEXT, READ PREV, RESET BR, and END BR requests) of the halfword value of REQID.
UEP_FC_NUMREC
Address of the fullword value of NUMREC, in which (if the request is DELETE with RIDFLD) the number of records that have been deleted is returned.
UEP_FC_KEY_COMPARISON
Address of a byte containing (for READ, START BR, and RESET BR requests) the key comparison setting.
UEP_FC_EQUAL
Key-equal-to comparison.
UEP_FC_GTEQ
Key-greater-than-or-equal-to comparison.
UEP_FC_GENERIC
Address of a byte containing (for READ, DELETE, START BR, and RESET BR requests) the generic key setting.
UEP_FC_GENERIC_KEY
Generic key used for key search.
UEP_FC_FULL_KEY
Full key used for key search.
UEP_FC_MASS_INSERT
Address of a byte containing (for WRITE requests) the mass insert setting.
UEP_FC_SEQUENTIAL_WRITE
Sequential mode.
UEP_FC_DIRECT_WRITE
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.)
UEP_FC_CR
Consistent read integrity.
UEP_FC_FCT_VALUE
Read integrity according to the setting in the FILE definition.
UEP_FC_NRI
No read integrity.
UEP_FC_RR
Repeatable read integrity.
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 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 contains the SYSID identifying the remote region. On input to the XFCFROUT exit, the area contains either:
  • The value of the SYSID option of the API call, or
  • Blanks (if SYSID was not specified), or
  • The value of the SYSID value specified by the XFCFRIN exit.
UEP_FC_LENGTH_ERROR_CODE
Address of a 1-byte area containing the length error code returned after the request completed. The possible values are:
  • UEP_FC_LENGTH_OK
  • UEP_FC_ BUFFER_LEN_TOO_SMALL
  • UEP_FC_RECORD_LEN_TOO_LARGE
  • UEP_FC_BUFFER_LEN_NOT_FILE_LEN
  • UEP_FC_RECORD_LEN_NOT_FILE_LEN
UEP_FC_DUPLICATE_KEY_CODE
Address of a 1-byte area indicating whether the request found more than one record for the supplied key. The possible values are:
  • UEP_FC_DUPLICATE KEY
  • UEP_FC_NOT_DUPLICATE KEY
UEP_FC_ACCMETH_RETURN_CODE
Address of a 4-byte area in which access-method-dependent information is returned when either of the responses UEP_FC_REASON_ACCMETH_REQUEST_ERROR or UEP_FC_REASON_IO_ERROR is returned.
UEP_FC_RESPONSE
Address of a 1-byte area containing the response after the request completed:
  • UEP_FC_RESPONSE_OK
  • UEP_FC_RESPONSE_EXCEPTION
  • UEP_FC_RESPONSE_DISASTER
  • UEP_FC_RESPONSE_INVALID
  • UEP_FC_RESPONSE_PURGED
UEP_FC_REASON
Address of a 1-byte area containing, if the request completed with an EXCEPTION response, the reason. The possible reasons are:
  • UEP_FC_REASON_ABEND
  • UEP_FC_REASON_ACCMETH_REQUEST_ERROR
  • UEP_FC_REASON_BDAM_DELETE
  • UEP_FC_REASON_BDAM_LENGTH_CHANGE
  • UEP_FC_REASON_BDAM_KEY_CONVERSION
  • UEP_FC_REASON_BDAM_READ_PREVIOUS
  • UEP_FC_REASON_BDAM_WRITE_MASS_INSERT
  • UEP_FC_REASON_BROWSE_UPD_NOT_RLS
  • UEP_FC_REASON_CACHE_FAILURE
  • UEP_FC_REASON_CFDT_CONNECT_ERROR
  • UEP_FC_REASON_CFDT_DISCONNECT_ERROR
  • UEP_FC_REASON_CFDT_INVALID_CONTINUATION
  • UEP_FC_REASON_CFDT_POOL_FULL
  • UEP_FC_REASON_CFDT_REOPEN_ERROR
  • UEP_FC_REASON_CFDT_SERVER_NOT_AVAILABLE
  • UEP_FC_REASON_CFDT_SERVER_NOT_FOUND
  • UEP_FC_REASON_CFDT_SYSIDERR
  • UEP_FC_REASON_CFDT_TABLE_GONE
  • UEP_FC_REASON_CHANGED
  • UEP_FC_REASON_CR_NOT_RLS
  • UEP_FC_REASON_DATASET_BEING_COPIED
  • UEP_FC_REASON_DEADLOCK_DETECTED
  • UEP_FC_REASON_DELETE_AFTER_READ_UPDATE
  • UEP_FC_REASON_DELETE_BEFORE_READ_UPDATE
  • UEP_FC_REASON_DISASTER_PERCOLATION
  • UEP_FC_REASON_DUPLICATE_READ_UPDATE
  • UEP_FC_REASON_DUPLICATE_RECORD
  • UEP_FC_REASON_DUPLICATE_REQID
  • UEP_FC_REASON_END_OF_FILE
  • UEP_FC_REASON_ESDS_DELETE
  • UEP_FC_REASON_FILE_DISABLED
  • UEP_FC_REASON_FILE_NOT_OPEN
  • UEP_FC_REASON_FILE_NOT_RECOVERABLE
  • UEP_FC_REASON_FILE_NOT_FOUND
  • UEP_FC_REASON_FULL_KEY_WRONG_LENGTH
  • UEP_FC_REASON_GENERIC_DELETE_NOT_KSDS
  • UEP_FC_REASON_GENERIC_KEY_TOO_LONG
  • UEP_FC_REASON_ILLEGAL_KEY_TYPE_CHANGE
  • UEP_FC_REASON_INSUFFICIENT_SPACE
  • UEP_FC_REASON_INVALID_UPDATE_TOKEN
  • UEP_FC_REASON_IO_ERROR
  • UEP_FC_REASON_ISCINVREQ
  • UEP_FC_REASON_ISC_NOT_SUPPORTED
  • UEP_FC_REASON_KEY_LENGTH_NEGATIVE
  • UEP_FC_REASON_KEY_STOLEN
  • UEP_FC_REASON_KSDS_AND_XRBA
  • UEP_FC_REASON_LOADING
  • UEP_FC_REASON_LOCKED
  • UEP_FC_REASON_LOST_LOCKS
  • UEP_FC_REASON_LOCK_STRUCTURE_FULL
  • UEP_FC_REASON_NOT_IN_SUBSET
  • UEP_FC_REASON_NO_VARIABLE_LENGTH
  • UEP_FC_REASON_NOSUSPEND_NOT_RLS
  • UEP_FC_REASON_NOTAUTH
  • UEP_FC_REASON_NOT_EXTENDED
  • UEP_FC_REASON_PREVIOUS_RLS_FAILURE
  • UEP_FC_REASON_RBA_ACCESS_TO_RLS_KSDS
  • UEP_FC_REASON_READ_NOT_AUTHORISED
  • UEP_FC_REASON_READPREV_IN_GENERIC_BROWSE
  • UEP_FC_REASON_RECLEN_EXCEEDS_LOGGER_BFSZ
  • UEP_FC_REASON_RECORD_BUSY
  • UEP_FC_REASON_RECORD_NOT_FOUND
  • UEP_FC_REASON_REMOTE_INVREQ
  • UEP_FC_REASON_RESTART_FAILED
  • UEP_FC_REASON_REWRITE_BEFORE_READ_UPDATE
  • UEP_FC_REASON_RIDFLD_KEY_NOT_RECORD_KEY
  • UEP_FC_REASON_RLS_DEADLOCK_DETECTED
  • UEP_FC_REASON_RLS_DISABLED
  • UEP_FC_REASON_RLS_FAILURE
  • UEP_FC_REASON_RR_NOT_RLS
  • UEP_FC_REASON_SECURITY_FAILURE
  • UEP_FC_REASON_SELF_DEADLOCK_DETECTED
  • UEP_FC_REASON_SERVREQ_VIOLATION
  • UEP_FC_REASON_SHIP
  • UEP_FC_REASON_SHIPPED_SECURITY_FAILURE
  • UEP_FC_REASON_STORE_FAIL
  • UEP_FC_REASON_SUPPRESSED
  • UEP_FC_REASON_SYSIDERR
  • UEP_FC_REASON_TABLE_FULL
  • UEP_FC_REASON_TABLE_TOKEN_INVALID
  • UEP_FC_REASON_TIMEOUT
  • UEP_FC_REASON_TOO_MANY_CFDTS_IN_UOW
  • UEP_FC_REASON_UNKNOWN_REQID_ENDBR
  • UEP_FC_REASON_UNKNOWN_REQID_READNEXT
  • UEP_FC_REASON_UNKNOWN_REQID_READPREV
  • UEP_FC_REASON_UNKNOWN_REQID_RESETBR
  • UEP_FC_REASON_UPDATE_NOT_AUTHORISED
UEP_FC_EXIT_TOKEN
Address of the 4-byte token passed from XFCFRIN.
Return codes
UERCNORM
Continue processing.
UERCPURG
Task purged during XPI call.
XPI calls
All can be used.
API and SPI calls
None can be used.