FCMT gate, INQUIRE_FILE function

Return information about the current state of a FILE resource.

Input Parameters

FILE_NAME
The name of the FILE resource.

Output Parameters

REASON
The following values are returned when RESPONSE is DISASTER:
  • TM_LOCATE_FAILED
  • TM_UNLOCK_FAILED
The following values are returned when RESPONSE is EXCEPTION:
  • FILE_NAME_NOT_FOUND
The following values are returned when RESPONSE is INVALID:
  • INVALID_PARAMETERS
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
ACCESS_METHOD
Optional Parameter
The access method used for the file.
Values for the parameter are:
  • BDAM
  • VSAM
ACTIVE_STRINGS
Optional Parameter
The current number of concurrent requests against the file.
ADD
A binary parameter that indicates whether records can be added to the file.
Values for the parameter are:
  • NO
  • YES
BASE_NAME
Optional Parameter
The name of the VSAM base cluster.
BASE_OBJECT_NAME
Optional Parameter
When the file is associated with a data set that is a VSAM base, the name of the base data set.
BLOCK_FORMAT
Optional Parameter
Indicates whether records on the file are blocked or unblocked.
Values for the parameter are:
  • BLOCKED
  • UNBLOCKED
BLOCK_KEY_LENGTH
Optional Parameter
The physical block key length for the file.
BLOCK_SIZE
Optional Parameter
The length in bytes of a block. If the blocks are of variable length or are undefined, the value returned is the maximum.
BROWSE
A binary parameter that indicates whether records can be retrieved sequentially from the file.
Values for the parameter are:
  • NO
  • YES
CF_LOAD
Optional Parameter
A binary parameter that indicates whether a coupling facility data table load is required.
Values for the parameter are:
  • NO
  • YES
CF_POOL
Optional Parameter
The name of the coupling facility data table pool containing the table defined by this file definition.
CF_UPDATE_MODEL
Optional Parameter
The type of update model to be used for a coupling facility data table.
Values for the parameter are:
  • CONTENTION
  • LOCKING
DATA_BUFFERS
Optional Parameter
The number of buffers to be used for data.
DELETE
A binary parameter that indicates whether records can be deleted from the file.
Values for the parameter are:
  • NO
  • YES
DISPOSITION
Optional Parameter
The disposition of this file.
Values for the parameter are:
  • OLD
  • SHARE
DSN_SHARING
Specifies whether VSAM data set name sharing is used for the VSAM file.
Values for the parameter are:
  • ALL_REQUESTS
  • MODIFY_REQUESTS
DT_NAME
Optional Parameter
The name of the coupling facility data table that is accessed through this file definition.
EMPTY_STATUS
Optional Parameter
Indicates whether the object associated with this file is to be set to empty when the file is opened.
Values for the parameter are:
  • EMPTY_REQUESTED
  • NO_EMPTY_REQUESTED
ENABLE_STATUS
Optional Parameter
Indicates that the initial state of the file is unenabled.
Values for the parameter are:
  • UNENABLED
EXCLUSIVE_CONTROL
Optional Parameter
A binary value that indicates whether records on this file are to be placed under exclusive control when a read for update is issued.
Values for the parameter are:
  • NO
  • YES
FILE_NAME
The name of the FILE resource.
FILE_TYPE
The location of the file.
Values for the parameter are:
  • LOCAL
  • REMOTE
FORWARD_RECOVERY_LOG
Optional Parameter
The journal that corresponds to the MVS system logger log stream that is to be used for forward recovery.
INDEX_BUFFERS
Optional Parameter
The number of buffers to be used for the index.
JOURNAL_ID
The identifier of the journal used for automatic journaling records.
JOURNAL_READ_ONLY
A binary parameter that indicates whether READ ONLY operations, and not READ UPDATE operations, are to be written to the journal.
Values for the parameter are:
  • NO
  • YES
JOURNAL_READ_SYNC
A binary parameter that indicates whether the automatic journaling records that are written for READ operations are to be written synchronously.
Values for the parameter are:
  • NO
  • YES
JOURNAL_READ_UPDATE
A binary parameter that indicates whether READ UPDATE operations, and not READ ONLY operations, are to be written to the journal.
Values for the parameter are:
  • NO
  • YES
JOURNAL_WRITE_NEW_AFTER
A binary parameter that indicates whether new records are to be written to the journal before they are written to the VSAM file.
Values for the parameter are:
  • NO
  • YES
JOURNAL_WRITE_NEW_BEFORE
A binary parameter that indicates whether new records are to be written to the journal after they are written to the VSAM file.
Values for the parameter are:
  • NO
  • YES
JOURNAL_WRITE_SYNC
A binary parameter that indicates whether the automatic journaling records that are written for WRITE operations are to be written synchronously.
Values for the parameter are:
  • NO
  • YES
JOURNAL_WRITE_UPDATE
A binary parameter that indicates whether the automatic journaling records that are written for REWRITE and DELETE operations are to be written synchronously.
Values for the parameter are:
  • NO
  • YES
KEY_LENGTH
Optional Parameter
The length in bytes of the logical key of records in remote files, and in coupling facility data tables that are not loaded when they are first loaded.
KEY_POSITION
Optional Parameter
The starting position of the key field in each record relative to the beginning of the record.
LSR_POOL_ID
The identity of the local shared resource (LSR) pool.
OBJECT
Optional Parameter
Indicates whether the file is associated with a data set (a VSAM KSDS, ESDS, or RRDS, or an alternate index used directly) or a VSAM path that links an alternate index to its base cluster.
Values for the parameter are:
  • BASE
  • PATH
OBJECT_NAME
Optional Parameter
When the file is associated with a data set that is a VSAM base, the name of the base data set.
OPEN_STATUS
Optional Parameter
Indicates whether the file is open, closed, or in a transitional state.
Values for the parameter are:
  • CLOSED
  • CLOSING
  • OPEN
  • OPENING
READ
A binary parameter that indicates whether records on this file can be read.
Values for the parameter are:
  • NO
  • YES
READ_INTEGRITY
Specifies the level of read integrity required for RLS files.
Values for the parameter are:
  • CR
  • NRI
  • RR
RECORD_FORMAT
The format (fixed- or variable-length) of records on the file.
Values for the parameter are:
  • FIXED
  • VARIABLE
RECORD_SIZE
Optional Parameter
The maximum length in bytes of records in a remote file or a coupling facility data table.
RECOVERY
The type of recovery required for the file.
Values for the parameter are:
  • ALL
  • BACKOUT_ONLY
  • NONE
RELATIVE_ADDR
Optional Parameter
Indicating whether relative or absolute addressing is used to access the file and the type of relative addressing.
Values for the parameter are:
  • BLOCK
  • DECIMAL
  • HEX
  • NONE
REMOTE_NAME
Optional Parameter
The name by which the file is known in the remote region.
REMOTE_SYSTEM
Optional Parameter
The name of the remote system where the file is located.
RLS
A binary parameter that indicates whether CICS is to open the file in RLS mode.
Values for the parameter are:
  • NO
  • YES
STRING_NUMBER
The number of concurrent requests that can be processed against the file.
TABLE_SIZE
Optional Parameter
The maximum number of records (entries) to be accommodated in the data table.
TABLE_TYPE
Optional Parameter
The type of data table.
Values for the parameter are:
  • CFDT
  • CICS
  • NOT_TABLE
  • USER
TYPE
Optional Parameter
The type of data set that corresponds to the file
Values for the parameter are:
  • ESDS
  • KEYED
  • KSDS
  • NOT_KEYED
  • RRDS
  • VRRDS
UPDATE
A binary parameter that indicates whether records on this file can be updated.
Values for the parameter are:
  • NO
  • YES
USING_LSR
Optional Parameter
A binary value that indicates if the file is using a local shared resource (LSR) pool.
Values for the parameter are:
  • NO
  • YES
VSAM_PASSWORD
Optional Parameter
The VSAM password for the file.


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