INQUIRE FILE/DATASET

Retrieve information about a file.

Options

ADD(cvda)

returns a CVDA value identifying whether new records can be added to the file. CVDA values are:

ADDABLE: New records can be added to the file.

NOTADDABLE: New records cannot be added to the file.

BASEDSNAME(data-area)

returns the 44-character name of the base cluster associated with a VSAM path, if the object associated with the file is a path. If the object is other than a path, this option returns the same value as the DSNAME option.

Note: The translator accepts BASENAME for this option, but you should use BASEDSNAME in new code.

BLOCKFORMAT(cvda)

returns a CVDA value identifying whether records on the file are blocked or unblocked. XCICS/TS always return BLOCKED.

BLOCKED: This is a VSAM file.

BROWSE(cvda)

returns a CVDA value identifying whether you can browse the file. CVDA values are:

BROWSABLE: You can browse the file.

NOTBROWSABLE: You cannot browse the file.

DELETE(cvda)

returns a CVDA value identifying whether you can delete records from the file. CVDA values are:

DELETABLE: You can delete records from the file.

NOTDELETABLE: You cannot delete records from the file.

DISPOSITION(cvda)

returns a CVDA value indicating the value of the DISPOSITION option for the file. CVDA values are:

SHARE: Disposition is SHARE.

DSNAME(data-area)

returns the 44-character name of the VSAM object associated with the FILE definition.

EMPTYSTATUS(cvda)

returns a CVDA value indicating whether EMPTYREQ has been set for the file. XCICS/TS always retruns NOEMPTYREQ. CVDA values are

NOEMPTYREQ: The data set should not be made empty.

ENABLESTATUS(cvda)

returns a CVDA value identifying whether application programs can access the file. CVDA values are:

DISABLED: The file is unavailable for access by application programs because it has been explicitly disabled.

ENABLED: The file is available for access by application programs.

FILE(data-value)

specifies the 8-character name of the file about which you are inquiring. This is an alias for DATASET.

DATASET(data-value)

specifies the 8-character name of the file about which you are inquiring.

KEYLENGTH(data-area)

returns a fullword binary field indicating the length of the record key for a file associated with a VSAM KSDS.

KEYPOSITION(data-area)

returns a fullword binary field indicating the starting position of the key field in each record relative to the beginning of the record. The start is made at position 0. If there is no key, or if the file is not open, CICS returns a value of zero for the key position.

OBJECT(cvda) (VSAM only)

always returns the CVDA value BASE.

OPENSTATUS(cvda)

returns a CVDA value identifying whether the file is open, closed, or in a transitional state. CVDA values are:

CLOSED: The file is closed.

OPEN: The file is open.

READ(cvda)

returns a CVDA value identifying whether you can read records from the file. CVDA values are:

NOTREADABLE: You cannot read records from the file.

READABLE: You can read records from the file.

RECORDFORMAT(cvda)

returns a CVDA value identifying the format of the records on the file. CVDA values are:

FIXED: The records are of fixed length.

VARIABLE: The records are of variable length. If the file is associated with a user-maintained data table, the record format is always variable length, even if the source data set contains fixed-length records.

RECORDSIZE(data-area)

returns a fullword binary field indicating the actual size of fixed-length records, or the maximum size of variable-length records.

RECOVSTATUS(cvda)

returns a CVDA value identifying whether the file is recoverable. CVDA values are:

NOTRECOVABLE: The file is not recoverable.

RECOVERABLE: The file is recoverable.

REMOTENAME(data-area)

returns the 8-character name by which the file is known in the XCICS region named in the REMOTESYSTEM option of its FILE definition. Blanks are returned if the file is not remote.

REMOTESYSTEM(data-area)

returns a 4-character name of the XCICS region in which the file is defined (from the REMOTESYSTEM value in the FILE definition). Blanks are returned if the file is not remote.

STRINGS(data-area)

supported only for backward compatibility reasons. Always retruns zero.

TYPE(cvda)

returns a CVDA value identifying the type of data set that corresponds to this file. CVDA values are:

ESDS: The data set is an entry-sequenced data set.

KSDS: The data set is a key-sequenced data set or the file refers to a data table.

RRDS: The data set is a relative record data set.

VRRDS: The data set is a variable--length relative record data set.

UPDATE(cvda)

returns a CVDA value identifying whether the file is updatable. CVDA values are:

NOTUPDATABLE: You cannot update records.

UPDATABLE: You can update records.