FCCT gate, OPEN function
This function defines a table and establishes a connection to it. A security check is performed for access to the table name. If the table does not exist, it is implicitly created.
Input Parameters
- TABLE_NAME
- 16-character table name. This name is typically the CICS® file name padded with trailing blanks.
- RECORD_LENGTH
- This fullword binary field specifies the table maximum record length, in the range 1 - 32767.
- KEY_LENGTH
- This fullword binary field specifies the table key length in bytes, in the range 1 - 16.
- MAXIMUM_RECORDS
- Optional Parameter
- This fullword binary field specifies the maximum number of records that can be stored in the table. If no maximum limit is required, the maximum positive number (hex 7FFFFFFF) can be specified.
- UPDATE_MODEL
- Specifies the method to be used for updating the table. Values
for the parameter are:
- CONTENTION
- Indicates that version compare and swap is used for updating the table.
- LOCKING
- Indicates that normal update locking is used for updating the table.
- RECOVERABLE
- Indicates that backout support is included with normal update locking.
- INITIAL_LOAD
- Optional Parameter
- Specifies whether initial load is required. If not, the first
open creates an empty table. Values for the parameter are:
- YES
- NO
- OPEN_MODE
- Optional Parameter
- Specifies the mode in which the file is opened. Values for the
parameter are:
- READ_ONLY
- READ_WRITE
- ACCESS_MODE
- Optional Parameter
- Specifies whether the table is being opened for exclusive or
shared use. Values for the parameter are:
- EXCLUSIVE
- SHARED
- PREFER_SHARED
- SHARED_ACCESS
- Optional Parameter
- Specifies for an exclusive mode open whether other users are allowed
shared access to the file at the same time. Values for the parameter
are:
- NONE
- READ_ONLY
- READ_WRITE
- TRANSACTION_NUMBER
- Optional Parameter
- This 4-character string identifies the requesting task in the debug trace if used.
Output Parameters
- ACCESS_MODE
- Optional Parameter
- Specifies whether the table is being opened for exclusive or
shared use. Values for the parameter are:
- EXCLUSIVE
- SHARED
- PREFER_SHARED
- CURRENT_RECORDS
- This fullword binary field indicates the number of records in the table the last time that the current server accessed the table.
- CURRENT_HIGH_KEY
- Optional Parameter
- This 16-character string indicates the key of the last record in the table at the time of the request.
- CURRENT_USERS
- This fullword binary field indicates the number of user opens that are currently active against the table.
- INITIAL_LOAD
- Specifies whether initial load is required. If not, the first open creates an empty table.
- Values for the parameter are:
- YES
- NO
- KEY_LENGTH
- This fullword binary field specifies the table key length in bytes, in the range 1 - 16.
- LOADED
- Optional Parameter
- Indicates whether the table has been loaded. If the table was created as empty, this parameter is set to YES as if loading had already taken place. If not, this parameter is set to YES using the SET function when loading is complete.
- This parameter takes one of the following values:
- YES
- NO
- MAXIMUM_RECORDS
- Optional Parameter
- This fullword binary field specifies the maximum number of records that can be stored in the table. If no maximum limit is required, the maximum positive number (hex 7FFFFFFF) can be specified.
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- SERVER_CONNECTION_FAILED
- TABLE_NOT_FOUND
- CF_ACCESS_ERROR
- RECORD_LENGTH
- This fullword binary field specifies the table maximum record length, in the range 1 - 32767.
- 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
- TABLE_TOKEN
- Token returned by the OPEN function which must be passed on all subsequent requests against that open table.
- UPDATE_MODEL
- Specifies the method to be used for updating the table. Values
for the parameter are:
- CONTENTION
- Indicates that version compare and swap is used for updating the table.
- LOCKING
- Indicates that normal update locking is used for updating the table.
- RECOVERABLE
- Indicates that backout support is included with normal update locking.