FS_PARAM

Get a logical file’s parameters

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
xcall FS_PARAM([rtrn_level], [record_size], [last_rec], [rtrn_channel], [which_level], 
&     [which_channel][, error])

Arguments

rtrn_level

(optional) Returned with the file-stack level. (n)

record_size

(optional) Returned with the record size of the logical file. (n)

last_rec

(optional) Returned with the last record written to the logical file. (n)

rtrn_channel

(optional) Returned with the file-stack channel. (n)

which_level

(optional) The file-stack level to access. (n)

which_channel

(optional) The file-stack channel to use. (n)

error

(optional) Returned with one of the following error flags: (n)

0 = No error occurred.

1 = Not a file-stack channel.

2 = File stack not active.

4 = No logical file stacked.

6 = Invalid file-stack level.

Discussion

FS_PARAM returns information about a given logical file for a given file-stack system.

If which_level is not passed or is passed and zero, the current (highest) logical file (level) will be used. If which_level is not specified and no logical file is currently active, rtrn_level will be set to zero and record_size and last_rec will be undefined. If which_channel is not passed, the default file stack will be used.

Examples

This example returns the current (highest) file-stack level in level, the record size of the current logical file in recsize, the last record written in lastrec, and any error in sts.

xcall fs_param(level, recsize, lastrec,,,, sts)