FCCR gate, READ function
This function reads a record in a coupling facility data table (CFDT) and, optionally, updates it.
Input Parameters
- BUFFER
- The input buffer for read requests.
- KEY
- The 16-byte key of the record to be accessed. For approximate key operations, this parameter specifies the start key and is updated on successful completion to contain the key of the record accessed.
- KEY_COMPARISON
- The comparison condition; this parameter can take the following
values:
- LT
- LTEQ
- EQ
- GTEQ
- GT
- KEY_MATCH_LENGTH
- The key match length for generic key operations.
- SUSPEND
- Specifies whether to wait if the requested record is locked by
an active lock. Values for the parameter are:
- YES
- NO
- TABLE_NAME
- This 16-character field contains the 8-character name of the CFDT and is padded with trailing blanks.
- TABLE_TOKEN
- The token returned by the OPEN function, which must be passed on all subsequent requests against that open table.
- TRANSACTION_NUMBER
- This 4-character string identifies the requesting task in the debug trace, if used.
- UOW_ID
- This 8-character string specifies the unit of work ID. The unit of work ID is required when updating using the locking model.
Output Parameters
- KEY
- Returns the 16-byte key of the record.
- LOCK_OWNER_APPLID
- This 8-character string identifies the applid of the region that owns the record lock for a RECORD_BUSY or RECORD_LOCKED condition. This parameter is also set when the wait exit is taken for a lock wait.
- LOCK_OWNER_SYSTEM
- This 8-character string identifies the MVS™ system from which the record lock was acquired for a RECORD_BUSY or RECORD_LOCKED condition. This parameter is also set when the wait exit is taken for a lock wait.
- LOCK_OWNER_UOW_ID
- This 8-character string identifies the unit of work that owns the record lock for a RECORD_BUSY or RECORD_LOCKED condition. This parameter is also set when the wait exit is taken for a lock wait.
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- SERVER_CONNECTION_FAILED
- RECORD_NOT_FOUND
- RECORD_BUSY
- RECORD_LOCKED
- TABLE_LOADING
- INVALID_REQUEST
- INCOMPLETE_UPDATE
- TABLE_TOKEN_INVALID
- TABLE_DESTROYED
- UOW_FAILED
- UOW_NOT_IN_FLIGHT
- UOW_TOO_LARGE
- POOL_STATE_ERROR
- CF_ACCESS_ERROR
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
- UPDATE_TOKEN
- Returns a token on a read for update.