FCFR gate, WRITE function
Write to a file.
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.
- MASS_INSERT
- A binary parameter that specifies whether the WRITE request is part of a mass-insert operation.
- Values for the parameter are:
- NO
- YES
- PRIVILEGED_REQUEST
- A binary parameter that indicates whether the request is privileged.
- Values for the parameter are:
- NO
- YES
- RECORD_ADDRESS
- The address of the target record.
- RECORD_ID_ADDRESS
- The address of the record identification field.
- RECORD_ID_TYPE
- The type of data contained in the record identification field.
- Values for the parameter are:
- DEBKEY
- DEBREC
- KEY
- RBA
- RRN
- CFDT_LOAD
- Optional Parameter
- A binary value that indicates whether the request is part of the browse operation used to read records from the source data set during loading of a coupling facility data table.
- Values for the parameter are:
- NO
- YES
- FCTE_POINTER
- Optional Parameter
- The address of the file control table entry (FCTE) for the file.
- RECORD_ID_LENGTH
- Optional Parameter
- The length of the record identifier.
- 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.
- 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_KEY_CONVERSION
- BDAM_WRITE_MASS_INSERT
- CACHE_FAILURE
- CFDT_CONNECT_ERROR
- CFDT_POOL_FULL
- CFDT_POOL_FULL
- CFDT_SERVER_NOT_AVAILABLE
- CFDT_SERVER_NOT_FOUND
- CFDT_SYSIDERR
- CFDT_TABLE_GONE
- DATASET_BEING_COPIED
- DEADLOCK_DETECTED
- DUPLICATE_RECORD
- FILE_DISABLED
- FILE_NOT_OPEN
- FULL_KEY_WRONG_LENGTH
- INSUFFICIENT_SPACE
- IO_ERROR
- KEY_LENGTH_NEGATIVE
- KEY_STOLEN
- LOADING
- LOCK_STRUCTURE_FULL
- LOCKED
- LOST_LOCKS
- NO_VARIABLE_LENGTH
- NOSUSPEND_NOT_RLS
- NOT_IN_SUBSET
- PREVIOUS_RLS_FAILURE
- RBA_ACCESS_TO_RLS_KSDS
- RECORD_BUSY
- RECORD_NOT_FOUND
- RESTART_FAILED
- RIDFLD_KEY_NOT_RECORD_KEY
- RLS_DEADLOCK_DETECTED
- RLS_DISABLED
- RLS_FAILURE
- SELF_DEADLOCK_DETECTED
- SERVREQ_VIOLATION
- SHIP
- SHIPPED_SECURITY_FAILURE
- STORE_FAIL
- SUPPRESSED
- SYSIDERR
- TABLE_FULL
- 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
- 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