.STREAM READ

This subroutine is called to read a file stream.

Usage:

      PASS         <read_buffer>              FIELD            SHARE? Y
      PASS         <stream_name>              FIELD            SHARE? N
      PASS         <read_length>              FIELD            SHARE? Y
      GOSUB    --- .STREAM READ
      *        check for errors
      IF       --- .STREAM READ               NE

Description:

This subroutine is called to read a file stream previously opened for READ access via .STREAM OPEN.

The first two parameters are required, and the subroutine will CANCEL if they are are not all received. The <read_length> parameter is optional.

<read_buffer> is the variable into which the data will be read (Required). This subroutine can read lines up to a maximum of 32000 characters. This must be passed SHARED to return any data.

<stream_name> is the name of the previously opened stream (Required).

<read_length> is the number of bytes to read (optional). If not passed, or if blank/zero is passed, it will read up until the line termination character specified in .STREAM OPEN. If passed shared, it will return the number of characters actually read, however, you should set it back to zero before the next GOSUB --- .STREAM READ, otherwise this subroutine will only read that number of characters.

If --- .STREAM READ contains 'Data was truncated', it means the <read_buffer> field you passed was not large enough to contain all the data that was read. If --- .STREAM READ contains 'EOF', then there is no more data to be read.

Comments:

Read what other users have said about this page or add your own comments.

-- JeanNeron - 2012-01-23