FS_READ

Read an existing record from a logical file

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
xcall FS_READ(record, number, [level], [channel][, error])

Arguments

record

Returned with the record read. (a)

number

The number of the record to read. (n)

level

(optional) The file-stack level from which to read. (n)

channel

(optional) The file-stack channel. If not passed, the default file-stack channel is used. (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.

5 = Illegal record number.

6 = Invalid file-stack level.

Discussion

FS_READ reads a record that exists in a logical file.

If error is not passed and an error occurs, a fatal program error is generated.

It is assumed that the size of the data transfer is the size of the accessed logical file’s record length, as specified in FS_OPEN.

Examples

This example reads the data stored in record 3 of the current level of the default file-stack into page. Any error will be returned in sts.

xcall fs_read(page, 3,,, sts)