FCFR gate, UNLOCK function
Release the lock on a file record.
Input Parameters
- 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
- ENVIRONMENT_IDENTIFIER
- A token that identifies the caller's environment.
- FILE_NAME
- The name of the FILE resource.
- TOKEN_REQUEST
- A binary value that indicates whether a token is supplied with the request.
- Values for the parameter are:
- NO
- YES
- CLEAR_AFTER_ABEND
- Optional Parameter
- A binary value that indicates whether the request follows a transaction abend, and that the environment must be cleared.
- Values for the parameter are:
- NO
- YES
- FCTE_POINTER
- Optional Parameter
- The address of the file control table entry (FCTE) for the file.
- 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
- DISASTER_PERCOLATION
- SECURITY_FAILURE
- The following values are returned when RESPONSE is EXCEPTION:
- CACHE_FAILURE
- CLEAR_ABENDED
- IO_ERROR
- PREVIOUS_RLS_FAILURE
- READ_NOT_AUTHORISED
- RLS_DISABLED
- RLS_FAILURE
- SHIPPED_SECURITY_FAILURE
- SYSIDERR
- 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.
- 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