FCCI gate, INQUIRE function

FCCI is the parameter list used by file control to communicate with the coupling facility data table (CFDT) cross-memory server, DFHCFMN, for the table inquire function.

Input Parameters

BROWSE
Optional Parameter
This parameter specifies whether the inquire is for a single table or for the first or next table in a browse. If this parameter is omitted, a single table inquire is performed. The FIRST option indicates a search for a table greater than or equal to the specified name, and NEXT indicates a search for a table greater than the specified name.
Values for the parameter are:
  • FIRST
  • NEXT
TABLE NAME
16-character table name; this name is typically the CICS file name padded with trailing blanks.
TRANSACTION_NUMBER
Optional Parameter
This 4-character string identifies the requesting task in the debug trace if used.

Output Parameters

ACCESS_MODE
Returned as EXCLUSIVE if the table is open for exclusive access; otherwise, SHARED.
This parameter can take the following values:
  • EXCLUSIVE
  • SHARED
AVAILABLE
Indicates whether new opens are currently allowed.
Values for the parameter are:
  • YES
  • NO
CURRENT_RECORDS
This fullword binary field indicates the number of records in the table the last time the current server accessed the table.
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
Indicates whether the table has been loaded. If the table was created as empty this is set to YES as if loading had already been done. If not, the value is set to YES using the SET function when loading is complete.
Values for the parameter are:
  • YES
  • NO
MAXIMUM_RECORDS
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.
OPEN_MODE
Indicates whether the table is currently open and, if so, whether it is open for read-only or read/write access.
This parameter can take the following values:
  • NONE
  • READ_ONLY
  • READ_WRITE
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.
SHARED ACCESS
If the table is currently open for exclusive access, this parameter indicates the level of shared access permitted by the exclusive user. If the table is not open for exclusive access, this parameter normally indicates that read and write sharing is allowed.
Values for the parameter are:
  • NONE
  • READ_ONLY
  • READ_WRITE
TABLE_NAME
The 16-character table name; this name is typically the CICS file name padded with trailing blanks.
UPDATE_MODEL
Specifies the method to be used for updating the table. This parameter takes one of the following values:
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.


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