Macro type: type S (E form, L form/C form/D form); see "Macro types"
The FSTAT macro returns information on catalog entries. The user can request information on one or more files, on file generations, or on file generation groups, as well as on all files under a specified user ID.
Users may retrieve information on all files under their own user IDs and on all other users' files that they are permitted to access (see the selection operands SHARE, BASACL, OWNERAR, GROUPAR, OTHERAR, GUARDS and PROTACT).
The selection of files for which the user requires information can be made as follows:
By specifying the path name. The catalog ID, user ID, and the fully or partially qualified file name (with or without wildcards) serve as selection criteria.If no path name is specified, all permanent files of the user's own user ID are selected from the standard catalog of the local computer. Temporary files must be addressed with the tempfile prefix (# or @).
The files selected via the “pathname” can be restricted further by the user by means of selection operands. Only those files which have the file attributes described by the selection operands are selected. If no selection operand is specified or if the value ANY (if allowed) is specified, the corresponding file attribute is not taken into account for the selection.
The scope and structure of the information to be retrieved for the selected files and transferred to the output area can be defined by the user in the OUTPUT operand as follows:
only the return information concerning macro execution (no information in the output area)
only the names of the selected files
statistics (e.g. number of selected files for each type of volume)
catalog information for each selected file.
The output of catalog information can be restricted by the user to one or more information blocks in which file attributes are grouped into logical units (CEINFO operand):
history block
security block
status block
backup block
organization block
allocation block
volumes block
volume extents block
index-info-block
FTAM information
Default value: all information blocks (without FTAM information)
The following sources of information can be selected by the user (see the FROM operand):
the standard catalog of the user ID
all catalogs of the local pubset
VTOC of a private disk or of a Net-Storage volume
The FSTAT macro is supported in six versions (see also VERSION operand):
Version 5 for BS2000 versions >= BS2000 OSD-BC V11.0
Version 4 for BS2000 versions >= BS2000/OSD-BC V9.0
Version 3 for BS2000 versions >= BS2000/OSD-BC V3.0
Version 2 for BS2000 versions >= BS2000/OSD-BC V1.0
Version 1 (corresponds to version 800) for BS2000 versions >= V8.0
Version 0 (corresponds to version 710) for BS2000 versions
<V8.0
Default setting: Version 0
This description of the FSTAT macro is based on the functionality of Version 5, which must be explicitly specified in the macro as VERSION=5. In the table "Version differences - VERSION=0/1/2/3/4/5", all deviations to the described version are combined for versions 0 to 5.
Format
Operation | Operands |
|
|
| |
| |
|
Operand descriptions
pathname
“pathname” defines the path name of the file(s) for which information is to be returned with: <filename 1..54 with-wild(80) without-gen>
Temporary files are not taken into account.
“pathname” means [:catid:][$userid][filename]
catid
Catalog ID;
Default value: the catalog ID assigned to the user ID
userid
User ID;
“$userid.” designates all files of this user. If the user ID of some other user is specified, information is returned on only those files which the caller of the macro is allowed to access.
Default value: the user's own user ID i.e. the one specified in the SET-LOGON-PARAMETERS or LOGON command.
filename
Fully or partially-qualified file name of permanent or temporary files, of file generations or file generation groups.
Wildcard specification
Nonprivileged users may only specify wildcards in “catid” and “filename” whereas the system administrator may also specify them in “userid” (for information on wildcards see "Wildcards").
Wildcards cannot replace the delimiters in the cat (colons) and user ($ sign and period) name parts.
ACCCNT
Returns information on all files that were accessed as often as specified.
The access counter can be assigned values from 0 to 2147483647.
= ANY
The access counter is not a selection criterion.
= nmbr
Returns information on files for which the access count exactly matches the specified value.
= (nmbr[,])
Returns information on files for which the access count is greater than or equal to the specified value.
= (,nmbr)
Returns information on files for which the access count is less than or equal to the specified value.
= (nmbr1,nmbr2)
Returns information on files whose access counters lie within the specified interval (nmbr1 <= access counter <= nmbr2).
ACCESS
Selects files/file generations on the basis of the access mode.
= ANY
The access mode is not a selection criterion.
= READ
Provides information about files/file generations for which only read access is permitted.
= WRITE
Provides information about files/file generations for which only write access is permitted.
ADMINFO
Returns information on files/file generations dependent on the system administrator metainformation.
= *ANY
The system administrator metainformation is not a selection criterion.
= *NONE
Returns information on files possessing no system administrator metainformation.
= <c-string 1..8>
Returns information on files with the specified system administrator metainformation.
AVAIL
Returns information on files/file generations dependent on their availability.
= *ANY
The availability is not a selection criterion.
= *STD
Returns information on files that are not on a volume set or an SF pubset with high availability.
= *HIGH
Returns information on files that are on disks set with high availability (DRV pubset).
BACKUP
Returns information on files/file generation groups, for which the specified ARCHIVE or HSMS backup level was defined.
= ANY
The backup level is not a selection criterion.
= A
Returns information on files/ FGGs with the attribute BACKUP=A.
= B
Returns information on file/FGGs with the attribute BACKUP=B.
= C
Returns information on files/FGGs with the attribute BACKUP=C.
= D
Returns information on files/FGGs with the attribute BACKUP=D.
= E
Returns information on files/FGGs with the attribute BACKUP=E.
= (list-of-backup)
More than one backup level may be specified in the form of a list. All files/FGGs which satisfy one of the given conditions (ORing) will be selected in such cases.
BASACL
Returns information on files which are selected on the basis of a defined BASIC-ACL.
= ANY
The BASIC-ACL is not a selection criterion.
= NONE
Returns information on all files for which no BASIC-ACL entry is defined.
= YES
Returns information on all files for which a BASIC-ACL entry is defined.
BLKCNT
For tape files only:
Selects files on the basis of the number of blocks on tape.
= ANY
The number of blocks on tape is not a selection criterion.
= nmbr
Returns information on all tape files with exactly the specified number of blocks.
= (nmbr[,])
Returns information on all tape files for which the number of blocks is greater than or equal to the specified value.
= (,nmbr)
Returns information on all tape files for which the number of blocks is less than or equal to the specified value.
= (nmbr1,nmbr2)
Returns information on all tape files for which the number of blocks lies within the specified interval.
Any integers from the range 0 <= value <= 2147483647 may be specified.
BLKCTRL
Selects files on the basis of the block format with which the file was defined (via the BLKCTRL operand in the FILE or FCB macro). The block format is defined when creating the file and is based on the existence and position of the block control field that contains management information for the PAM page.
= ANY
The file format is not a selection criterion.
= DATA
Returns information on all files for which the block control information is located at the start of the data block. Such files are created with BLKCTRL=DATA (see the FILE macro).
= PAMKEY
Returns information on all files which use a separate PAM key for the block control field, i.e. files for which the block control information is stored in a special key field outside the PAM block. Such files are created with BLKCTRL=PAMKEY (see the FILE macro).
= NO
Returns information on all files which contain no block control field. Such files are created with BLKCTRL=NO (see the FILE macro).
= NONE
Returns information on all files for which no BLKCTRL value was defined, i.e. files which have not yet been opened.
= DATA2K
Returns information on all files which were created with BLKCTRL=DATA2K (see the FILE macro).
= DATA4K
Returns information on all files that were created with BLKCTRL=DATA4K (see the FILE macro).
= NK2
Returns information on all NK2 files (files which can be stored on NK2 volumes).
= NK4
Returns information on all NK4 files (files which can be stored on NK4 volumes).
= (list-of-blkctrl)
Returns information on all files that match one of the specified block formats. All values except ANY may be specified in a list.
CCS
Returns information on files selected on the basis of the specified coded character set.The coded character set (CCS) defines how the characters of a national character set are to be stored in binary form. The specified character set has an effect on the representation of characters on the screen, the collating sequence, etc. (see the “XHCS” manual [22]).
= *ANY
The code table is not a selection criterion.
= *NONE
Only files for which no character set is defined are selected.
= ccs-name
Only files with the specified character set are selected.
CEINFO
The information from the catalog is arranged logically into information blocks. Only the information blocks explicitly selected by the user are output.
The CEINFO operand can be used to control the generation of a DSECT or CSECT.
If CEINFO is not specified or if CEINFO=ALL is set, all output blocks (except for the FTAM block) are generated. Otherwise, only those output blocks which are specified in CEINFO are generated.
= ALL
Transfers all the information stored in the catalog to the output area (OUTAREA) for the selected files.
The information shown is divided into the following information blocks: HISTORY / SECURITY / STATUS / BACKUP / ORGANIZATION / ALLOCATION / VOLUMES / VOLUME-EXTENTS (or INDEX-INFO)
File transfer information (FTAM) cannot be output by using CIENFO=ALL. This information, which is only relevant for file transfers, is output with CEINFO=FTAM only.
= HISTORY
Transfers the history block to the output area for the selected files, i.e. all file attributes related to the file history (on UTC basis):
access counter
date of last access
time of last access
date of last write access
time of last write access
creation date
time of creation
number of secondary allocations
= SECURITY
Transfers the security block to the output area for all selected files, i.e. all file attributes that affect file security (the bytes intended for file passwords are set to binary 0.
Exception: See the PASSW operand):
type of access (standard access control)
file monitoring
automatic data destruction on deletion
protection with an execute password
date on which the file may be updated
time related to EXPIR-DATE
protection against read access by a guard
protection against write access by a guard
protection against execute access by a guard
access rights of user class “group” (BASIC-ACL)
access rights of user class “others” (BASIC-ACL)
access rights of file owner (BASIC-ACL)
protection with read password
protection against release of storage space
shareability attribute (standard access control)
protection with write password
= STATUS
Transfers the status block for all selected files to the output area, i.e. all file attributes that affect special characteristics of the file. These include:
SPECIAL-ACCOUNTING-BIT
OPEN-CLOSE flag
REPAIR flag
PSEUDO-CLOSE flag
VERIFY-IS-FORBIDDEN flag
LOCKS (RELEASE-LOCK; ERASE-LOCK; OUTPUT-LOCK; CATALOG-LOCK; SPD-LOCK)
= BACKUP
Transfers the backup block for all selected files to the output area, i.e. all the backup attributes of files. These include:
the backup level for ARCHIVE or HSMS
the specification regarding whether the file may be migrated
the specification regarding whether the file is always to be fully saved
the version as an internal ARCHIVE attribute
- the number of file versions that the file takes part in the version backup with
= ORGANIZATION
Transfers the organization block for all selected files to the output area, i.e. all file attributes that are related to the file organization:
block counter (tape files)
buffer offset (tape files)
block type (standard or nonstandard block)
coded character set (CCS) with XHCS support
coded character set for node files on Net-Storage (NETCCS)
code specification for tape files
suitability of file for processing in a cache
file sequence number (tape file)
access method when the file was created
performance requirement for file processing
type of I/O operations to which the performance requirement applies
length of ISAM key
position of ISAM key
standard version of labels (tape files)
length of logical ISAM flag
propagation of ISAM flag
record format
record length
length of the ISAM value flag
file type on Net-Storage
file size of node files
= ALLOCATION
Transfers the allocation block for the selected files to the output area, i.e. all file attributes that affect storage space allocation:
device type for the volume
total number of extents for the file
highest used PAM page (last-page pointer)
secondary allocation for file extension
storage level for migrated files
type of volume
VSN (volume serial number) of the volume used
last valid byte on the last logical page of the file (last-byte pointer and validity indicator for the last-byte pointer)
= VOLUMES
Transfers the volume tables for the selected files to the output area. These tables contain the following information:
VOLUME
DEVICE
#EXTENTS
flag indicating whether an ISAM-INDEX or ISAM-DATA volume is involved
= VOLUME-EXTENTS
Transfers the volume tables and the extent lists for the selected files to the output area.
= INDEX-INFO
Transfers the INDEX-INFO block for the selected files to the output area, i.e. all file attributes that affect the file generation group:
base value for relative generation numbers
first or last cataloged file generation
oldest existing file generation
maximum number of simultaneously cataloged generations
overflow handling on reaching the maximum number
= FTAM
Transfers the FTAM block for the selected files to the output area, i.e. all file attributes related to file transfer.
Since this output block is only relevant for file transfer, the FT block is not output for CEINFO=ALL.
= (list-of-ceinfo)
With the exception of FTAM and ALL, all operand values may be specified in a list. The corresponding information blocks are then transferred to the output area. The order in which the operands are specified is of no consequence.
CRDATE
Allows the user to select files for processing on the basis of their creation dates.
Date values may be supplemented by specifying a time. The rules for date and time specifications are described in section "Format of date specifications". Range specifications are inclusive of both specified limits.
= ANY
The creation date is not a selection criterion.
= NONE
Returns information on all files for which no creation date has been entered in the catalog, i.e. files which have not yet been opened.
= date
Returns information on all files that were created on the specified date.
= (date[,])
Returns information on all files that were created on or after the specified date (creation date >= current date).
= (,date)
Returns information on all files that were created on or before the specified date (creation date <= current date).
= (date1,date2)
Returns information on all files that were created within the specified period (date1 <= creation date <= date2).
= date(time[,])
Returns information on all files that were created on the specified date on or after the specified time.
= date(time1,time2)
Returns information on all files that were created on the specified date within the specified period.
= (date(time)[,])
Returns information on all files that were created on or after the specified date and time.
= (,date(time))
Returns information on all files that were created before the specified date and time.
= (date1(time),date2(time))
Returns information on all files that were created within the specified period. The upper and lower limits of the specified period are defined more precisely by a time specification in both cases.
DELDATE
Allows the user to select files on the basis of the DELETION-DATE (the time as of which the file may be deleted irrespective of its protection attributes).
The user can supplement the date values by specifying a time. It must be noted in this respect that the deletion time of 00:00:00 is currently always entered in the file catalog.The rules for date and time specifications are described in section "Format of date specifications". Range specifications include both specified limits.
= *ANY
The DELETION-DATE is not a selection criterion.
= *NONE
Returns information on all files for which no DELETION-DATE is entered in the catalog.
= date
Returns information on all files for which the specified DELETION-DATE is defined.
= (date[,])
Returns information on all files whose DELETION-DATE is later than or equal to the specified date.
= (,date)
Returns information on all files whose DELETION-DATE is earlier than or equal to the specified date.
= (date1,date2)
Returns information on all files whose DELETION-DATE lies within the specified time period (date1 <= DELETION-DATE <= date2).
= date(time[,])
Returns information on all files for which the specified DELETION-DATE is defined and for which the delete time is later then or equal to the specified time. The delete time (time in relation to the DELETION-DATE) is currently always entered in the catalog as 00:00:00.
= date(time1,time2)
Returns information on all files for which the specified DELETION-DATE is defined and for which the delete time is within the specified time period. The delete time (time in relation to the DELETION-DATE) is currently always entered in the catalog as 00:00:00.
= (date(time)[,])
Returns information on all files whose DELETION-DATE and time is later than or equal to the specified time. The delete time (time in relation to the DELETION-DATE) is currently always entered in the catalog as 00:00:00.
= (,date(time))
Returns information on all files whose DELETION-DATE and time is earlier than or equal to the specified time. The delete time (time in relation to the DELETION-DATE) is currently always entered in the catalog as 00:00:00.
= (date1(time),date2(time))
Returns information on all files whose DELETION-DATE lies within the specified time period (date1 <= DELETION-DATE <= date2). The upper and lower limits of the specified time period are defined more precisely by specifying a time.
DISKWR
Enables the user to select files for processing based on the time at which data consistency is required for them, as defined in the catalog entry.
= ANY
The time at which data consistency is required, as defined in the catalog, is not a selection criterion.
= IMMEDIATE
Returns information on all files for which data consistency is required immediately after a write operation is completed. Such files are not suitable for processing in a write cache.
= BY-CLOSE
Returns information on all files for which data consistency is not required until CLOSE processing. These files are suitable for processing in a write cache.
ENCRYPT
Enables the user to select files based on whether or with which encryption method they are encrypted.
= *ANY
Processes all files regardless of whether or with which encryption method they are encrypted.
= *NONE
Processes only those files which are not encrypted.
= *AES
Processes only those files which are encrypted with the AES encryption method.
= * DES
Processes only those files which are encrypted with the DES encryption method.
= (list_of_encrypt)
Processes only those files which meet one of the specified selection criteria. All values except ANY can be specified in the list.
EXDATE
The user can select files to be processed on the basis of their expiration date. The expiration date of a file is defined in the catalog and specifies when the file may be updated again or deleted. If no expiration date is defined when creating the file, the expiration date is set to the creation date.
The user may supplement date specifications by a time value; however, it should be noted that the time stamp for the expiration date is always set to 00:00:00 in the file catalog at present. The rules for date and time specifications are described in section "Format of date specifications". Ranges defined in intervals include both specified limits.
= ANY
The expiration date is not a selection criterion.
= NONE
Returns information on all files for which no expiration date has been entered in the catalog, i.e. files that have not yet been opened.
= date
Returns information on all files for which the specified expiration date is defined.
= (date[,])
Returns information on all files for which the expiration date is greater than or equal to the specified date.
= (,date)
Returns information on all files for which the expiration date is less than or equal to the specified date.
= (date1,date2)
Returns information on all files for which the expiration date lies within the specified period (date1 <= expiration date <= date2).
= date(time[,])
Returns information on all files with the specified expiration date and with an expiration time that is greater than or equal to the specified time.
Note that the time of expiration (i.e. the time on the expiration date) is always entered as 00:00:00 hours in the catalog at present!
= date(time1,time2)
Returns information on all files with the specified expiration date and with a time of expiration that lies within the specified time interval.
Note that the time of expiration (i.e. the time on the expiration date) is always entered as 00:00:00 hours in the catalog at present!
= (date(time)[,])
Returns information on all files for which the expiration date and time is greater than or equal to the specified time.
Note that the time of expiration (i.e. the time on the expiration date) is always entered as 00:00:00 hours in the catalog at present!
= (,date(time))
Returns information on all files for which the expiration date and time is less than or equal to the specified time.
Note that the time of expiration (i.e. the time on the expiration date) is always entered as 00:00:00 hours in the catalog at present!
= (date1(time),date2(time))
Returns information on all files for which the expiration date lies within the specified period (date1 <= expiration date <= date2). The upper and lower limits of the specified period are defined more precisely by time values in both cases.
EXTENTS
Only for files on disk or Net-Storage:
returns information on files selected on the basis of the specified number of extents. An extent is a contiguous area occupied by a file on a disk. The number of extents which make up a file is stored in the catalog.
The possible values for “nmbr” are: 0 <= nmbr <= 65535.
Range specifications include both upper and lower limits.
= ANY
The number of extents is not a selection criterion.
= nmbr
Only the disk files with exactly the specified number of extents are processed.
= (nmbr [,])
Only the disk files with at least the specified number of extents (number of extents >= nmbr) are processed.
= (,nmbr)
Only the disk files that have at most the specified number of extents (number of extents <= nmbr) are processed.
= (nmbr1, nmbr2)
Only the disk files that have at least as many extents as “nmbr1” and at most as many extents as “nmbr2” (i.e. nmbr1 <= number of extents <= nmbr2) are processed.
FCBTYPE
Selects and returns information on files/file generations on the basis of the access method with which they were created. If multiple access methods are listed, all files that satisfy one of the listed conditions (logical OR) are selected by the system.
= ANY
The access method is not a selection criterion.
= NONE
Returns information on files that are cataloged but which contain no data, i.e. files which have not yet been opened or files for which storage space has been released with ERASE..., SPACE.
= ISAM
Returns information on ISAM files.
= BTAM
Returns information on BTAM files.
= SAM
Returns information on SAM files.
= PAM
Returns information on PAM files.
= (list-of-fcbtype)
More than one access method may be specified in a list. Information on all files that were created with one of the specified access methods will be shown.
FILTYPE
Returns information on all files which match the specified file type.
= *ANY
Returns information on both BS2000 files and on node files.
= *BS2000
Returns information only on BS2000 files.
= *NODE
Returns information only on node files (files which can be created and modified by BS2000 and open systems).
FROM
The FROM operand defines the source for the FSTAT information.
= CATALOG
The FSTAT macro retrieves information from the catalog of the default pubset of the user ID, i.e. from the catalog with the default catalog ID.
= LOCALPVS
The FSTAT macro retrieves information from the system catalogs of all selected local pubsets.
= (vsn,device)
The FSTAT macro retrieves information from the directory of the private disk identified by “vsn” or from the catalog of the Net-Storage volume identified by “vsn”.
The device type (“device”) of the private disk must be specified; see the “Device table” in the „System installation“ manual [16] for possible values. The operands VOLUME, SUPPORT and VTOC are not permitted.
FSIZE
For disk files only:
Returns information on files/file generation groups based on the amount of free (i.e. reserved but not used) storage space; 0 <= nmbr <= 16777215
= ANY
The size of the free (i.e. reserved but not used) storage space is not a selection criterion.
= SIZE
Returns information on files for which the number of free PAM pages is equal to the number of reserved pages.
= nmbr
Returns information on files with exactly the specified number of reserved but unused PAM pages.
= (nmbr[,])
Returns information on files with at least the specified number of reserved but unused PAM pages.
= (,nmbr)
Returns information on files with no more than the specified number of reserved but unused PAM pages.
= (nmbr1,nmbr2)
Returns information on files for which the number of free pages lies within the specified range (nmbr1 < nmbr2).
GEN
The “GEN” operand defines whether information on file generations is to be output.The interaction of this operand with the specification TYPE=FGG is illustrated in the following table:
TYPE=FGG | GEN=YES | GEN=NO | Information | Information on file | Information |
x | x | * | * | - | |
x | x | * | - | - | |
x | * | * | * | ||
x | * | - | * |
x | specified in the FSTAT macro |
* | taken into account for macro processing |
- | not taken into account for macro processing |
= NO
No information on file generations is output.
= YES
File generation information is output.
The specification GEN=YES is ignored if no “filename” is specified in “pathname”.
GROUPAR
Selects and returns information on files on the basis of the access rights that are defined for members of the file owner's user group in BASIC-ACL entries.
= ANY
The BASIC-ACL entries for members of the file owner's user group are not used as a selection criterion.
= NO-ACCESS
Returns information on all files that cannot be accessed by the user group of the owner.
= access-list
Returns information on all files for which at least one of the access rights specified in the list has been entered for the user group of the file owner in the BASIC-ACL entry.
access-list has the following format:
Long format:
([READ=YES / READ=NO][,WRITE=YES / WRITE=NO][,EXEC=YES / EXEC=NO])Short format:
([R=Y / R=N][,W=Y / W=N][,X=Y / X=N])
The parentheses constitute part of the operand value and must be specified.
The individual elements of the access list mean the following:
READ=YES or R=Y | Selects all files that may be accessed for reading by the user group of the owner. |
READ=NO or R=N | Selects all files that cannot be accessed for reading by the user group of the owner. |
WRITE=YES or W=Y | Selects all files that may be accessed for writing by the user group of the owner. |
WRITE=NO or W=N | Selects all files that cannot be accessed for writing by the user group of the owner. |
EXEC=YES or X=Y | Selects all files that may be executed by the user group of the owner. |
EXEC=NO or X=N | Selects all files that cannot be executed by the user group of the owner. |
GUARDS
The user can select files to be processed on the basis of the access protection defined by GUARDS (see the “SECOS” manual [8]).
= *ANY
The access protection defined by GUARDS is not a selection criterion.
= *NONE
Returns information on all files which have no access protection defined by GUARDS.
= *YES
Returns information on all files which have access protection defined by GUARDS.
= (READ=...,WRITE=...,EXEC=...)
The type of access protection provided by GUARDS that is to be used as a selection criterion can be defined by the user in a list. For each access mode (read, write, and execute), the defined protection can be specified precisely. If no entry is made for an access mode, the protection defined for that access mode has no effect on the selection.
For each access mode, one of the following values may be specified:
*ANY | The defined GUARDS protection is not a selection criterion. |
*NONE | No guard has been defined for the specified access mode, i.e. the corresponding access is denied. |
fname | All conditions for granting access in the specified access mode are defined in the guard fname. |
IOPERF
Performance attribute of the file; returns information on all files based on the performance attribute that is defined for them in the catalog (see IOPERF operand in the CATAL macro).
= ANY
The performance attribute is not a selection criterion.
= STD
Returns information on all files for which the performance attribute was defined as STD.
= HIGH
Returns information on all files for which the performance attribute was defined as HIGH (high performance priority).
= VERY-HIGH
Returns information on all files for which the performance attribute was defined as VERY-HIGH (highest performance priority).
= (list-of-ioperf)
Up to three performance attributes may be specified in a list. All files that have one of these specified attributes will be shown.
IOUSAGE
Returns information on all files, depending on the type of I/O operations to which the performance attribute applies (see the IOUSAGE operand in the CATAL macro).
= ANY
The performance attribute is not a selection criterion.
= RDWRT
Returns information on all files for which the performance attribute applies to read and write operations.
= WRITE
Returns information on all files for which the performance attribute applies to write operations only.
= READ
Returns information on all files for which the performance attribute applies to read operations only.
= (list-of-iousage)
More than one type of I/O operation may be specified in a list. All files for which the performance attribute applies to at least one of the specified I/O operations will be shown.
LADATE
Returns information on all files with the corresponding date of last access.
The user can supplement date specifications by specifying time values. The rules for date and time specifications are described in section "Format of date specifications".
Ranges specified in intervals include both upper and lower limits.
= ANY
The date of last access is not a selection criterion.
= NONE
Returns information on all files for which no last access date has been entered in the catalog, i.e. files that have not yet been opened.
= date
Selects files which were last accessed on the specified date.
= (date[,])
Returns information on all files that were last accessed on or after the specified date (last access date >= date).
= (,date)
Selects all files that were accessed on or before the specified date (last access date <= date).
= (date1,date2)
Returns information on all files that were last accessed during the specified period (date1 <= last access date <= date2).
= date(time[,])
Returns information on all files that were last accessed on the specified date on or after the specified time.
= date(time1,time2)
Selects all files that were last accessed on the specified date and within the specified period.
= (date(time)[,])
Selects all files that were last accessed on or after the specified date and time.
= (,date(time))
Selects all files that were last accessed before the specified date and time.
= (date1(time),date2(time))
Selects all files that were last accessed within the specified period. The upper and lower limits of the specified period are defined more accurately by means of a time specification.
LASTPAG
Selects and returns information on files based on the amount of storage space used (i.e. the number of PAM pages written).
= ANY
The amount of storage space used is not a selection criterion.
= nmbr
Returns information on all files for which exactly the specified number of PAM pages have been written.
= (nmbr,)
Returns information on all files for which at least the specified number of PAM pages have been written.
= (,nmbr)
Returns information on all files for which no more than the specified number of PAM pages have been written.
= (nmbr1,nmbr2)
Returns information on all files for which the number of written PAM pages lies in the specified area (nmbr1 < nmbr2).
LBPOINT
Informs about files depending on of the attribute of the last-byte pointer (LBP).
= *ANY
The last-byte pointer is not a selection criterium.
= *NO
Informs about files without valid last-byte pointer.
= *YES
Informs about files with valid last-byte pointer.
= *ZERO
Informs about files with valid last-byte pointer with the value zero.
= *NONZERO
Informs about files with valid last-byte pointer with another value than zero.
LCDATE
Returns information on all files based on the date on which they were last accessed for writing.
The user can supplement date specifications by means of time values. The rules for date and time specifications are described in section "Format of date specifications". Ranges defined by intervals include both the specified limits.
= ANY
The date of the last write access is not a selection criterion.
= NONE
Returns information on all files for which no date of last write access is entered in the catalog, i.e. files that have not yet been opened.
= date
Returns information on all files that were last written to (i.e. changed) on specified date.
= (date[,])
Returns information on all files that were last changed on or after the specified date (last change date >= date).
= (,date)
Returns information on all files that were last changed on or before the specified date (last change date <= date).
= (date1,date2)
Returns information on all files that were last changed during the specified period (date1 <= last change date <= date2).
= date(time[,])
Returns information on all files that were last changed on the specified date on or after the specified time.
= date(time1,time2)
Returns information on all files that were last changed on the specified date and within the specified period.
= (date(time)[,])
Returns information on all files that were last changed on or after the specified date and time.
= (,date(time))
Returns information on all files that were last changed before the specified date and time.
= (date1(time),date2(time))
Returns information on all files that were last changed within the specified period. The upper and lower limits of the specified period are defined more precisely by time values.
MANCLAS
Returns in formation on all files according to the HSMS management class for file backup to SM pubsets.
= *ANY
The HSMS management class is not a selection criterion.
= *NONE
All files for which no HSMS management class is defined are selected.
= <c-string 1..8>
All files with the specified HSMS management class are selected.
MF
The forms of the MF operand are described in detail in the appendix ("Macro types"). All macros which differ with respect to the MF operand (MF = L/E/D/..) must have the same value for the VERSION operand.
Special facility with MF=D/C:
The user can control which output blocks are to be generated (XPAND=OUTPUT) by means of the CEINFO operand. With MF=D/C, only those blocks which the user has specified with CEINFO are expanded.
MIGRATE
Returns information on all files that have the specified entry for MIGRATE in the catalog. This entry is evaluated by the Hierarchical Storage Management System (HSMS) for the migration of files (see the MIGRATE operand in the CATAL macro on "CATAL - Process catalog entry"). If multiple values are listed, all files that satisfy one of the conditions are selected.
= ANY
The MIGRATE entry is not a selection criterion.
= ALLOWED
Selects only those files for which MIGRATE=ALLOWED was defined in the catalog entry, i.e. files which may be migrated to storage level S1 or S2.
= INHIBIT
Selects only those files for which MIGRATE=INHIBIT was defined in the catalog entry, i.e. files which may be briefly migrated (e.g. for reorganization purposes).
= FORBIDDEN
Returns information on files for which MIGRATE=FORBIDDEN is entered in the catalog entry, i.e. the files which must not be migrated.
= (list-of-migrate)
The ALLOWED and INHIBIT values may be specified by the user in a list. All files for which one of the specified values was defined in the catalog will be shown.
OTHERAR
Selects and returns information on files based on the access rights that are defined via BASIC-ACL entries for all users other than the file owners's user group.
= ANY
The BASIC-ACL entries for all users other than the file owner's user group do not serve as a selection criterion.
= NO-ACCESS
Returns information on all files that may be accessed by users not belonging to the file owner's user group.
= access-list
Returns information on all files for which at least one of the listed access rights has been defined for users not in the file owner's user group in the BASIC-ACL entries.
access-list has the following format:
Long format:
([READ=YES / READ=NO][,WRITE=YES / WRITE=NO][,EXEC=YES / EXEC=NO])Short format:
([R=Y / R=N][,W=Y / W=N][,X=Y / X=N])
The parentheses form part of the operand values and are mandatory.
The individual elements of the access list mean the following:
READ=YES or R=Y | Selects all files that can be accessed for reading by users who are not in the owner's user group. |
READ=NO or R=N | Selects all files that cannot be accessed for reading by users who are not in the owner's user group. |
WRITE=YES or W=Y | Selects all files that can be accessed for writing by users who are not in the owner's user group. |
WRITE=NO or W=N | Selects all files that cannot be accessed for writing by users who are not in the owner's user group. |
EXEC=YES or X=Y | Selects all files that may be executed by users who are not in the owner's user group. |
EXEC=NO or X=N | Selects all files that cannot be executed by users who are not in the owner's user group. |
OUTAREA
Output area for information from the catalog entry.
= (<list-of-elements-002>)
The output area is output in list form, consisting of:
The output area address. It can be output as a constant or equate and must be aligned on a word boundary.
The length of the output area in bytes. The value to be output depends on the scope of the information requested via the OUTPUT operand.It can be output as a constant or equate.
The format of the output area is described on "Programming notes (VERSION=2, 3 and 4)".
Note
SPECIFIED bits are set internally for the two output areas (OUTAREA and STOUTAR). In order to enable output, the corresponding AREA-SPECIFIED bit must be set. These bits are set when MF=L applies. It is therefore advisable to supply dummy values for the OUTAREA or STOUTAR operands in an MF=L call.
OUTPUT
The output layout in blocks comprises two independent sections containing information from the catalog entry and statistics on all selected catalog entries. For more information on the various information blocks, see "Programming notes (VERSION=2, 3 and 4)".
The information from the catalog entry is transferred to the output area specified by the OUTAREA operand.
Statistics are shown in the output area defined by the STOUTAR operand.
= RC-ONLY
Only the return code is shown, so no output area is required.
= FNAM-ONLY
Only the path names (with PVSID, USERID and FILENAME) are copied to the output area (see the description on "Programming notes (VERSION=2, 3 and 4)").
The path names are copied to the output area specified by the OUTAREA operand.
= CEINFO
Returns information on the catalog entries. The information to be shown can be controlled via the CEINFO operand. No statistics are output (see description on "Programming notes (VERSION=2, 3 and 4)").
The information from the catalog entry is copied to the output area specified by the OUTAREA operand.
= STAT-SHORT
Only the statistics are copied to the corresponding output area (see description on "Programming notes (VERSION=2, 3 and 4)").
The statistics are copied to the output area specified by the STOUTAR operand.
Note
No statistics can be retrieved if the operand FROM=(volume,device) is specified at the same time. Function calls in which this is done are rejected with return code DMS0576.
= STAT-LONG
Only the statistics are transferred to the output area. In addition to the output of STAT-SHORT, individual statistics for the PVSID and USERID are also shown (see the description on "Programming notes (VERSION=2, 3 and 4)").
The statistics are copied to the output area specified by the STOUTAR operand.
Note
No statistics can be retrieved if the operand FROM=(volume,device) is specified at the same time. Function calls in which this is done are rejected with return code DMS0576.
= STAT-INFO
Outputs information on the catalog entries as well as the statistics (corresponds to the output set CEINFO + STAT-LONG).
Both sections of the output are linked by pointers (see the description on "Programming notes (VERSION=2, 3 and 4)").
The information from the catalog entry is transferred to the output area specified by the OUTAREA operand; statistics are copied to the output area specified by the STOUTAR operand.
Note
No statistics can be retrieved if the operand FROM=(volume,device) is specified at the same time. Function calls in which this is done are rejected with return code DMS0576.
OWNERAR
Returns information on files selected on the basis of the access rights that are defined for the file owner in the BASIC-ACL entries.
= ANY
BASIC-ACL entries for the file owner are not used as a selection criterion.
= NO-ACCESS
Returns information on all files that the owner is not allowed to access.
= access-list
Returns information on all files for which at least one of the listed access rights has been defined for the file owner in the BASIC-ACL entry.
access-list has the following format:
Long format:
([READ=YES / READ=NO][,WRITE=YES / WRITE=NO][,EXEC=YES / EXEC=NO])Short format:
([R=Y / R=N][,W=Y / W=N][,X=Y / X=N])
The parentheses form part of the operand value and must be specified.
The individual elements of the access list mean the following:
READ=YES or R=Y | Selects all files that may be accessed by the owner for reading. |
READ=NO or R=N | Selects all files that cannot be accessed by the owner for reading. |
WRITE=YES or W=Y | Selects all files that can be accessed by the owner for writing. |
WRITE=NO or W=N | Selects all files that cannot be accessed by the owner for writing. |
EXEC=YES or X=Y | Selects all files that may be executed by the owner. |
EXEC=NO or X=N | Selects all files that the owner is not allowed to execute. |
PASS
Selects and returns information on files/file generation groups on the basis of the password protection defined with CATAL. If several password types are specified in the form of a list, all files that satisfy one of the named conditions (logical OR) are selected by the system. Passwords are not output.
= ANY
Password protection is not used as a selection criterion.
= NONE
Selects files for which no password protection exists.
= RDPASS
Selects files which are protected by means of a read password.
= WRPASS
Selects files which are protected by a write password.
= EXPASS
Selects files which are protected by an execute password.
= (list-of-pass)
The user may specify more than one type of password in the form of a list. All files protected by one of the specified password types will be shown.
PASSW
The PASSW operand determines how passwords are copied to the output area.
= NO
Default value: passwords are not explicitly displayed in the output area; the corresponding fields are set to binary 0.
= YES
For privileged users only:
passwords are explicitly represented in the output area.
PREFIX
Only evaluated in conjunction with MF=C or MF=D. Defines which characters the field names and equates generated during macro expansion in the data area are to begin with.
Default value: | PREFIX = D |
= pre
“pre” is a one-character prefix with which the field names and equates generated by the assembler are to begin.
PREFORM
Returns information on files dependent on their (intended) file format on SM pubsets.
= *ANY
The file format is not a selection criterion.
= *NONE
Returns information on all files for which no PREFORMAT value is defined.
= *K
Returns information on all files with the intended *K file format.
= *NK2
Returns information on all files with the intended *NK2 file format.
= *NK4
Returns information on all files with the intended *NK4 file format.
= (list-of-preform)
Returns information on all files which correspond to one of the specified file formats. Any value apart from ANY can be specified within the list.
PROTACT
Selects and retrieves information on files on the basis of the protection level provided by the highest activated access control.
When the file is accessed, the highest activated protection level applies. The following table shows the method used for access control, the protection attribute to be specified in the CATAL macro and the file protection hierarchy (protection levels):
Access control method | Protection attribute | Protection level |
Standard access control | ACCESS and SHARE | 0 |
Basic access control list | BASACL, OWNERAR, GROUPAR, OTHERAR | 1 |
Access control using GUARDS | GUARDS | 2 |
All other protection attributes of the file (e.g. passwords) are evaluated independently, without regard to the implemented protection level.
= ANY
is the default value; returns information on all files without regard to the protection level of the highest activated access control.Time specifications must always be made on UTC basis.
= LEVEL-0
Returns information on files for which access is controlled via standard access control.
= LEVEL-1
Returns information on files for which access is controlled via a basic access control list (BASIC-ACL protection).
= LEVEL-2
Returns information on files for which access is controlled by GUARDS.
= (list-of-protact)
The user may specify up to a maximum of three protection levels in a list. All files for which the protection level of the access control method matches one of those specified are selected.
RELSPAC
Returns information on files selected on the basis of the lock to prevent the release of unused memory space (as defined in the FILE macro or the MODIFY-FILE-ATTRIBUTES command). The lock can be defined in the catalog by using the CATAL macro.
= ANY
The lock to prevent the release of unused memory space is not used as a selection criterion.
= ALLOWED
Returns information on files for which unused memory space may be released.
= IGNORED
Returns information on files for which the release of unused memory space is not permitted.
SHARE
Selects and retrieves information on files or file generation groups based on whether or not they are shareable. If a foreign user ID which is not co-owner is specified with “$userid.”, SHARE=YES applies implicitly (see also the SHARE operand in the CATAL macro).
= ANY
Shareability is not used as a selection criterion.
= YES
Returns information on all files that are shareable, i.e. which are also accessible to other user IDs under active standard access control.
= NO
Returns information on all files that are not shareable, i.e. that are only accessible to the owner under active standard access control.
= SPECIAL
Returns information on files which can be accessed by all user IDs, including maintenance IDs (i.e. user IDs with hardware maintenance privileges).
= (list-of-share)
One or more operand values may be specified in a list.
SIZE
Returns information on files/file generations based on the size of the reserved storage space. Whole numbers between 0 and 2147483647 can be used as values.
= ANY
The size of the reserved storage space is not used as a selection criterion.
= FSIZE
Returns information on files for which the number of reserved PAM pages is equal to the number of free pages.
= nmbr
Returns information on files with exactly the specified number of reserved PAM pages.
= (nmbr[,])
Returns information on files with at least the specified number of reserved PAM pages.
= (,nmbr)
Returns information on files no more than the specified number of reserved PAM pages.
= (nmbr1,nmbr2)
Returns information on files for which the number of reserved PAM pages lies in the specified range (nmbr1 < nmbr2).
SLEVEL
Returns information on files selected on the basis of the level in the storage hierarchy at which they are held (see the “HSMS” manual [10]). The following three storage levels are supported by HSMS (Hierarchical Storage Management System):
S0: | implemented as fast access disk storage (for online processing) |
S1: | implemented as high capacity disk storage (background level, available online) |
S2: | implemented as a magnetic tape and tape cartridge archive (background level, available offline) |
= ANY
The storage level is not used as a selection criterion.
= S0
Selects only the files which are being held at level S0.
= S1
Selects only the files which are being held at level S1.
= S2
Selects only the files which are being held at level S2.
= (list-of-slevel)
The user may specify more than one storage level in the form of a list.
SORT
The SORT operand defines how catalog entries/path names are sorted in the output.
= FILENAM
Catalog entries/path names are output in alphabetical order.
= NO
Catalog entries/path names are output in the order in which they are located in the catalog.
STATE
Returns information on files selected on the basis of their current processing state.
= ANY
The current processing status is not a selection criterion.
= NOCLOS
Returns information on all files which have been opened for writing and are not closed. Such files include:
normally open files (OPEN mode OUTIN, INOUT, OUTPUT)
files not closed in a previous session
files not closed in the current session because of job abortion.
Note
STATE=NOCLOS implies GEN=YES, i.e. opened file generations are always output.
= CLOSED
Returns information on all files that have already been closed, i.e. files not selected by NOCLOS.
= CACHED
Returns information on the files which are currently cached.
= NOT-CACHED
Returns information on all files which are not being currently processed in a cache.
= CACHE-NOT-SAVED
Returns information on all files for which it was not possible to write the cache to a disk when they were closed.
= REPAIR-NEEDED
Returns information on all files which were not closed in an earlier session and which have not yet been verified (see the VERIFY macro).
= DEFECT-REPORTED
Returns information on all files which could contain defective disk blocks.
= NO-OPEN-ALLOWED
Returns information on all files which cannot be opened due to data inconsistency.
= OPEN-ALLOWED
Returns information on all files that can be opened.
= (list-of-state)
A list of values may be specified (with a maximum of 7 file states). The output shows all files which are in one of the specified states.
STOCLAS
Returns information on all files according to the file storage class on SM pubsets.
= *ANY
The storage class is not a selection criterion.
= *NONE
All files for which no storage class is defined are selected.
= <c-string 1..8>
All files with the specified storage class are selected.
STOTYPE
Return information on all files according to the storage type.
= *ANY
The storage type is not a selection criterion.
= *PUBSPACE
Only files on public volumes are selected.
= *NETSTOR
Only files on Net-Storage volumes are selected.
STOUTAR
Output area for statistics.
= (<list-of-elements-002>)
The output area is output in list form, consisting of:
Address of the output area. It may only be specified as a constant or equate and must be aligned on a word boundary.
Length of the output area (in bytes). The value to be specified here depends on the scope of the information requested with the OUTPUT operand.
It may only be specified as a constant or equate.
The format of the output area is described on "Programming notes (VERSION=2, 3 and 4)".
Note
SPECIFIED bits are set internally for the output areas OUTAREA and STOUTAR. The appropriate AREA-SPECIFIED bit must be set to enable the output. Since these bits are set with MF=L or MF=M, it is usually meaningful to supply dummy values for these operands in an MF=L call.
SUPPORT
Selects and returns information on files, file generations, or file generation groups (FGGs) on the basis of the type of volume on which they are stored.
= ANY
The volume type is not used as a selection criterion.
= PUBLIC
Returns information on files, file generations or FGGs which are stored on public volumes or Net-Storage volumes.
= PRDISC
Returns information on files, file generations or FGGs which are stored on private disk.
= TAPE
Returns information on files, file generations or FGGs which are stored on tape.
= (list-of-support)
A list of values may be specified (with up to 3 volume types). The output shows all files which are stored on one of the specified volume types.
S0MIGR
Returns information on files dependent on whether reallocation (migration) to S0 level is permitted.
= *ANY
The migration allowance is not a selection criterion.
= *ALLOWED
Returns information on files for which migration within the S0 level is permitted.
= *FORBIDDEN
Returns information on files for which migration within the S0 level is not permitted.
= (list-of-s0migr)
The user can specify the required values in a list. This returns information on all files for which one of the specified values was defined in the catalog.
TIMBASE
Controls whether the absolute date is entered in UTC or local time. The date format of the FSTAT output is also linked to this operand.
= *UTC
Absolute dates are input and output in UTC time.
= *LTI
Absolute dates are input and output in local time.
TYPE
Returns information on files selected on the basis of their type.
= ANY
Returns information on all files irrespective of their type.
= FILE
Returns information on all files with the exceptions of file generation groups.
= FGG
Returns information on file generation groups and, when GEN=YES is specified, also on file generations (see operand "GEN").
= PLAM
Returns information on PLAM libraries. This is a subset of the files which are selected by the specification TYPE=FILE.
= (list-of-type)
Returns information on all files that match one of the specified types. A maximum of three file types can be specified by the user in the form of a list.
USRINFO
Returns information on files/file generations dependent on user metainformation.
= *ANY
The user metainformation is not a selection criterion.
= *NONE
Returns information on files which have no user metainformation.
= <c-string 1..8>
Returns information on files with the specified user metainformation.
VERSION
Specifies which version of the parameter list is to be generated.
Note
If FSTAT is called in VERSION=0/1 in an environment that supports “large files” then a check, and possibly a conversion, will have to be performed. For more detailed information on this subject, refer to "Programming notes for VERSION=0 and VERSION=1".
= 0
Default value: generates the parameter list format that was supported prior to BS2000 V8.0A. This format will, however, only support the parameters which were known at that time. For example, the path name can only be specified without wildcards, and only VOLUME and POS are permitted as selection parameters. The supported operands and operand values can be found in the table "Version differences - VERSION=0/1/2/3/4/5".
= 1
Generates the parameter list format that was supported from BS2000 V8.0 through BS2000 V10.0.
This format will also support only the parameters that were known at the time. The supported operands and operand values can be found in the table "Version differences - VERSION=0/1/2/3/4/5".
= 2
Generates the parameter list format for versions as of BS2000/OSD-BC V1.0.
= 3
Generates the parameter list format for versions as of BS2000/OSD-BC V3.0.
= 4
Generates the parameter list format for versions as of BS2000/OSD-BC V9.0.
= 5
The parameter list format for versions BS2000 OSD/BC V11.0 and higher is generated.
Note
If existing software which manipulates the generated parameter list is to be recompiled or reassembled, the old format must be requested. Otherwise, source code compatibility is ensured.
VERSION-BACKUP
The user can select the files to be processed depending on whether they are part of the version backup.
= *ANY
Files are selected irrespective of whether they take part in the version backup.
= *ENABLED
Informs about all files that are part of the version backup (NUM-OF-BACKUP-VERS > 0).
= *DISABLED
Informs about all files that are not part of the version backup (NUM-OF-BACKUP-VERS = 0).
VOLSET
The user can select the files to be processed via the volume set on which they reside.
= *ANY
The volume set is not a selection criterion.
= *CONTROL
Returns information on all files on the control volume set of the SM pubset.
= <c-string 1..4>
Returns information on all files on the specified volume set.
VOLUME
The user can select files to be processed on the basis of the VSN (volume serial number) of the disk on which they are stored.
= ANY
The VSN of the volume is not a selection criterion.
= vsn
Returns information on all files/file generation groups which contain an entry for the volume with the specified VSN in their volume list. If “vsn” does not designate a private disk, no information is returned on file generation groups.
VTOC
The user can decide whether the requested information is to be obtained from the VTOC (= Volume Table of Contents) of a private disk or of a Net-Storage volume or from the system file catalog TSOSCAT. The VTOC operand cannot be used on partially-qualified file names or in combination with GEN=YES.
= NO
Outputs the current entry in the TSOSCAT.
= YES
Returns the VTOC catalog entries (from the F1 label of a private disk or the catalog of a Net-Storage volume) in accordance with the last current status in the entire computer network. The corresponding volume list must be assigned. The VTOC entry from the volume replaces the corresponding TSOSCAT entry. This makes it possible to restore consistency between the VTOC and TSOSCAT entries. If the specified file no longer exists on the volume shown in the TSOSCAT entry, the TSOSCAT entry is deleted.
WORKFIL
Returns information on files on SM pubsets dependent on whether they can be deleted by the system administrator (work files).
= *ANY
Whether or not the files are work files is not a selection criterion.
= *NO
Returns information on all files which are not work files.
= *YES
Returns information on all files which are work files.
WTQUIET
Controls whether the end of the QUIET state is to be waited for with a shared or remote imported pubset that was in the QUIET state at the time of the FSTAT call. This wait time is defined with DIALOG-WAIT-TIME or BATCH-WAIT-TIME in the corresponding MRSCAT entry.
Otherwise, the job is either aborted immediately with return code DMS0502 or, if the catalog ID contains wildcards, the pubset is skipped.
= *YES
If a pubset is in the QUIET state, this leads to a wait state.
= *NO
If a pubset is in the QUIET state, this either leads to return code DMS0502 or, if the catalog ID contains wildcards, the pubset is skipped.
XPAND
Controls which input parameter area is to be generated (with or without an area for selection parameters). XPAND can also be used to generate data descriptions (DSECTs) for the output area.
= PLSHORT
Generates the input parameter area without an area for selection parameters.
= PLLONG
Generates the input parameter area with an area for selection parameters.
= OUTPUT
Generates all DSECTs to describe the output information blocks.
= (PLSHORT,OUTPUT)
The input parameter area is generated without an area for selection parameters; all DSECTs to describe the output information blocks are generated.
= (PLLONG,OUTPUT)
The input parameter area is generated with an area for selection parameters; all DSECTs to describe the output information blocks are generated.
Return codes
The error code is only returned in the parameter list standard header and no longer in general-purpose register 15 as with version 2.
Note
If the catid entry contains wildcards, the following return codes are suppressed.
X'02000000'
X'00400501'
X'00400503'
X'00400505'
X'00400616'
X'00820502'
X'00820504'
X'00820506'
If no other error occurs and a file was selected, code 0 is returned and, if no file was selected, DMS06CC is returned.
Standard header: ccbbaaaa
The following code relating to execution of the FSTAT macro is returned in the standard header (cc = SUBCODE2, bb = SUBCODE1, aaaa = MAINCODE):
X'cc' | X'bb' | X'aaaa' | Meaning |
X'00' | X'0000' | No error | |
X'02' | X'00' | X'0000' | Output incomplete because of defective volume set; |
X'40' | X'0501' | Requested catalog not available | |
X'82' | X'0502' | Requested catalog in the quiet state | |
X'40' | X'0503' | Incorrect information in the MRSCAT | |
X'82' | X'0504' | Error in catalog management system | |
X'40' | X'0505' | Computer communication error (MRS) | |
X'80' | X'0506' | Operation aborted because of master change | |
X'40' | X'0510' | Error when calling an internal function | |
X'40' | X'0512' | Requested catalog unknown | |
X'40' | X'051B' | User ID unknown in specified pubset | |
X'40' | X'051C' | No access right to specified pubset | |
X'40' | X'051D' | LOGON password for specified pubset is different | |
X'40' | X'052E' | Volume no longer available | |
X'20' | X'0530' | Storage space request error | |
X'20' | X'0531' | Unexpected catalog access error | |
X'40' | X'0533' | Specified file not found | |
X'82' | X'0534' | Private volume cannot be allocated | |
X'20' | X'053B' | System error during file access | |
X'40' | X'053D' | Catalog or F1 label block is destroyed | |
X'20' | X'054F' | Unexpected error while accessing JOIN file | |
X'82' | X'055A' | Device currently reserved | |
X'40' | X'055F' | Volume could not be reserved | |
X'01' | X'0576' | Conflicting operand combination or the reserved fields of the parameter area were used or selection contains large files | |
X'20' | X'0577' | Internal error while accessing the job environment | |
X'82' | X'0594' | Not enough virtual memory available (also if wildcards were used and too many files were selected) | |
X'01' | X'0599' | Operand is not supported in the RFA-BS version | |
X'01' | X'05A8' | Requested device type not found in the system | |
X'01' | X'05AB' | Output area address incorrect or not specified | |
X'82' | X'05B0' | No suitable device currently available | |
X'40' | X'05B4' | Volume cannot be made available | |
X'40' | X'05D1' | Device request error | |
X'01' | X'05EA' | VTOC=YES is illegal with partially qualified file name or file generation group | |
X'01' | X'05EE' | File name too long | |
X'40' | X'05FC' | Specified user ID not in home pubset | |
X'40' | X'0616' | Output not possible because of defective volume set; | |
X'01' | X'06B8' | Invalid operand specified | |
X'01' | X'06C7' | Invalid generation number specified | |
X'xx' | X'00' | X'06CB' | Output area too short |
X'40' | X'06CC' | Only with selection entry (wildcard): | |
X'01' | X'06FD' | Parameter area invalid or not accessible | |
X'40' | X'06FF' | BCAM connection severed | |
X'01' | X'FFFF' | Incorrect function number in parameter area header | |
X'03' | X'FFFF' | Incorrect version number in parameter area header |