FCFR gate, REWRITE function
Rewrite a file record.
Input Parameters
- BACKOUT
- A binary value that indicates whether the request is issued during transaction backout.
- Values for the parameter are:
- NO
- YES
- BYPASS_SECURITY_CHECK
- A binary value that indicates that security checking can be omitted for the current request.
- Values for the parameter are:
- NO
- YES
- CONDITIONAL
- A binary value that indicates whether the request should wait if VSAM is holding an active lock against the record, including records locked as the result of a DEADLOCK. CONDITIONAL(YES) corresponds to option NOSUSPEND on the CICS API.
- Values for the parameter are:
- NO
- YES
- ENVIRONMENT_IDENTIFIER
- A token that identifies the caller's environment.
- FILE_NAME
- The name of the FILE resource.
- RECORD_ADDRESS
- The address of the target record.
- TOKEN_REQUEST
- A binary value that indicates whether a token is supplied with the request.
- Values for the parameter are:
- NO
- YES
- FCTE_POINTER
- Optional Parameter
- The address of the file control table entry (FCTE) for the file.
- RECORD_LENGTH
- Optional Parameter
- The length of the record.
- REMOTE_FILE_NAME
- Optional Parameter
- The file name in the remote system.
- REMOTE_SYSTEM
- Optional Parameter
- The SYSID of the remote system.
- UPDATE_TOKEN
- Optional Parameter
- A token that identifies an update request, and allows subsequent requests to refer to it.
- WORK_ELEMENT_ADDRESS
- Optional Parameter
- The address of the current file request thread element (FRTE).
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- CFDT_REOPEN_ERROR
- DISASTER_PERCOLATION
- SECURITY_FAILURE
- The following values are returned when RESPONSE is EXCEPTION:
- BDAM_LENGTH_CHANGE
- CACHE_FAILURE
- CFDT_CONNECT_ERROR
- CFDT_INVALID_CONTINUATION
- CFDT_POOL_FULL
- CFDT_SERVER_NOT_AVAILABLE
- CFDT_SERVER_NOT_FOUND
- CFDT_SYSIDERR
- CFDT_TABLE_GONE
- CHANGED
- DEADLOCK_DETECTED
- DUPLICATE_RECORD
- INSUFFICIENT_SPACE
- IO_ERROR
- KEY_STOLEN
- LOCK_STRUCTURE_FULL
- LOCKED
- NO_VARIABLE_LENGTH
- NOSUSPEND_NOT_RLS
- PREVIOUS_RLS_FAILURE
- RECORD_BUSY
- RECORD_NOT_FOUND
- REWRITE_BEFORE_READ_UPDATE
- RLS_DEADLOCK_DETECTED
- RLS_DISABLED
- RLS_FAILURE
- SELF_DEADLOCK_DETECTED
- SERVREQ_VIOLATION
- SHIPPED_SECURITY_FAILURE
- STORE_FAIL
- SYSIDERR
- TIMEOUT
- TOO_MANY_CFDTS_IN_UOW
- UPDATE_NOT_AUTHORISED
- VSAM_REQUEST_ERROR
- The following values are returned when RESPONSE is INVALID:
- INVALID_FORMAT
- INVALID_FUNCTION
- INVALID_UPDATE_TOKEN
- ACCMETH_RETURN_CODE
- The return code from the file access method for request.
- LENGTH_ERROR_CODE
- A value that provides details of a length error that occurred when processing the request.
- Values for the parameter are:
- BUFFER_LEN_NOT_FILE_LEN
- BUFFER_LEN_TOO_SMALL
- LENGTH_OK
- RECORD_LEN_NOT_FILE_LEN
- RECORD_LEN_TOO_LARGE
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- TERMINATE_REMOTE_REQUEST
- A binary value that indicates whether a remote file request should be terminated.
- Values for the parameter are:
- NO
- YES
- TERMINATE_STRING
- A binary value that indicates whether the FRTE string should be terminated.
- Values for the parameter are:
- NO
- YES