Version variations in the representation of the output area

Version=0 (corresponds to Version=710)

The scope of information written to the output area depends on whether a partially-qualified file name, a fully-qualified file name of an FGG (file generation group), or a fully-qualified file name is specified.

Partially-qualified file name or fully qualified file name of an FGG:

Only a list of file names is written to the output area.

length	file name
length	file name
:     :	:       :
length	file name	end	control

length

Length of the file name. The value of the length field is equal to the “length of the file name + 1 byte for the size of the length field”. This defines the offset to the next length field.

The name of a group entry is followed by the string '_(FGG)'. The value of the length field is then equal to the “length” of the group name + 1 byte for the size of the length field + 6 bytes for the string '_(FGG)'.

filename

File name (maximum 41 bytes).

end

Indicates the end of the list (X'00') (1 byte).

control

Indicates whether the output area was large enough to accommodate all file names (1 byte).

X'00'	Complete output: all file names were transferred to the output area.
X'01'	Incomplete output: one or more file names could not be transferred to the output area, because it was already full.

Fully-qualified file names

The output format is defined by means of the SHORT and LONG operands:

SHORT	The statistics section of the catalog entry is transferred to the output area (at least 60 bytes). The IDCE macro generates a DSECT that produces the layout of the output area.
LONG	The complete catalog entry consisting of statistics section file name extension volume table file table FGG suffix is shown in the output area (at least 2032 bytes).

If the value specified for the length of the output area (in the “length” operand, which corresponds to the length of the operand OUTAREA or STOUTAR in Vers=2) is not sufficient, no information is transferred.
For more information on generating DSECTs for the output area, see also the description of the SHORT operand on "Version variations in the representation of the output area".

Example

06 PETER OB ACCOUNTS 00 00

Version=1 (correspnds to Version=800)

Returns information on permanent or temporary files, file generations, or file generation groups that are specified by means of fully or partially qualified names.

The size and layout of the output area depends on the scope of the information requested for the files via the operands FNAM, SHORT and LONG.

FNAM

A list of file names is transferred to the output area. The address and length of the output area are assigned by means of the operands “outaddr” and “length₂”, respectively.
(With Vers=2, these operands correspond to the operand values “addr” and “length” of the operand OUTAREA).
The output area must have a length of at least 73 bytes.

information_header
data
:                 :
data	end1	end2	control

Total number of selected files (4 bytes)The information_header contains

• Length of the prefix and data that follows (4 bytes)

• Prefix:

  • length of the prefix (2 bytes)

  • length of the catalog ID + 2 (2 bytes)

  • catalog ID for all following entries

  • length of the user ID + 2 (2 bytes)

  • user ID for all following entries

The data area contains:

• length of the usage information that follows + 2 (2 bytes)

• file name (max. 41 bytes)

The output area is terminated by

end1	End-of-list flag for the data area (2 bytes, X'0000')
end2	End-of-list flag for the output area (4 bytes, X'00000000')
control	Return information on the execution of the FSTAT call (1 * byte)
	X'00': All the requested information was transferred to the output area X'01': The requested information could not be fully transferred to the output area.

SHORT

Returns the statistics stored in the catalog entry for each file name.
The address and length of the output area are assigned by means of the operands “outaddr” and “length₂”, respectively.
(With Vers=2, these operands correspond to the operand values “addr” and “length” of the operand STOUTAR.)
The information header and the end1, end2, and control areas correspond to the representation for the FNAM operand.

The data area contains:

• statistics section of the catalog entry; the last byte contain the length of the following file name (60 bytes)

• file name (max. 41 bytes)

In other words, the data area for SHORT has a maximum length of 101 bytes.
The output area for SHORT must be at least 133 bytes long. The IDCE macro generates a DSECT that creates the layout of the output area.

LONG

The complete catalog entry is output for each file name. The address and length of the output area are assigned by means of the operands “outaddr” and “length₂”, respectively.
(With Vers=2, these operands correspond to the operand values “addr” and “length” of the operand STOUTAR.)
The information header and the end1, end2, and control areas correspond to the representation for the FNAM operand.

The data area contains:

• statistics section

• file name

• extension

• volume table

• file table

• FGG suffix

The output area for LONG must have a length of at least 2064 bytes.

Note

The general-purpose registers 1 and 15 must not be specified for r₁, r₂ and r₃, and the specifications for r₁, r₂, and r₃ must constitute mutually exclusive pairs (logical OR).