FCFR gate, READ_INTO function

Read a file record into a buffer provided by the caller.

Input Parameters

BUFFER_ADDRESS
The address of the caller's buffer.
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.
GENERIC
A binary value that specifies whether the search key is a generic key.
Values for the parameter are:
  • NO
  • YES
KEY_COMPARISON
A value that specifies whether the search can be satisfied only by a record having the same key as that specified in the record identification field parameter, or by a record having a greater key.
Values for the parameter are:
  • EQUAL
  • GTEQ
READ_INTEGRITY
Specifies the degree of read integrity for the request.
Values for the parameter are:
  • CR
  • FCT_VALUE
  • NRI
  • RR
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
BASE_RECORD_ID_ADDRESS
Optional Parameter
The address of the base record identifier.
BUFFER_LENGTH
Optional Parameter
The length of the caller's buffer.
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.
REMOTE_FILE_NAME
Optional Parameter
The file name in the remote system.
REMOTE_SYSTEM
Optional Parameter
The SYSID of the remote system.
SUPPRESS_LENGERR
Optional Parameter
A binary value that indicates whether length error indications are to be suppressed.
Values for the parameter are:
  • NO
  • YES
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
  • TABLE_TOKEN_INVALID
The following values are returned when RESPONSE is EXCEPTION:
  • BDAM_KEY_CONVERSION
  • CACHE_FAILURE
  • CFDT_CONNECT_ERROR
  • CFDT_SERVER_NOT_AVAILABLE
  • CFDT_SERVER_NOT_FOUND
  • CFDT_SYSIDERR
  • CFDT_TABLE_GONE
  • CR_NOT_RLS
  • FILE_DISABLED
  • FILE_NOT_OPEN
  • FILENOTFOUND
  • FULL_KEY_WRONG_LENGTH
  • GENERIC_KEY_TOO_LONG
  • IO_ERROR
  • ISC_NOT_SUPPORTED
  • ISCINVREQ
  • KEY_LENGTH_NEGATIVE
  • LOADING
  • LOCKED
  • LOST_LOCKS
  • NO_VARIABLE_LENGTH
  • NOSUSPEND_NOT_RLS
  • NOT_IN_SUBSET
  • NOTAUTH
  • PREVIOUS_RLS_FAILURE
  • RBA_ACCESS_TO_RLS_KSDS
  • READ_NOT_AUTHORISED
  • RECORD_BUSY
  • RECORD_NOT_FOUND
  • REMOTE_INVREQ
  • RLS_DEADLOCK_DETECTED
  • RLS_DISABLED
  • RLS_FAILURE
  • RR_NOT_RLS
  • SELF_DEADLOCK_DETECTED
  • SERVREQ_VIOLATION
  • SHIP
  • SHIPPED_SECURITY_FAILURE
  • SYSIDERR
  • TIMEOUT
  • 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.
DUPLICATE_KEY
When the data set is being accessed by way of an alternate index path that allows non-unique alternate keys, a binary value that indicates whether further records exist with the same alternate key.
Values for the parameter are:
  • NO
  • YES
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
RECORD_LENGTH
Optional Parameter
The length of the record.
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
MAXIMUM_RECORD_LENGTH
The length of the longest record in the data set.


dfhs3_FCFRread_into.html | Timestamp icon Last updated: Monday, 5 June 2017