Difference: 0LASubrStreamRead (6 vs. 7)

Revision 72014-03-28 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPXRuntimeSubroutineAPI"

.STREAM READ

This subroutine is called to read a file stream.


Changed:
<
<

Usage: (5.3.1 or earlier)

>
>

Usage: (Option 1)

 
      PASS         <read_buffer>              FIELD            SHARE? Y
      PASS         <stream_name>              FIELD            SHARE? N
      PASS         <read_length>              FIELD            SHARE? Y

Line: 13 to 13
 
    • check for errors IF --- .STREAM READ NE
Changed:
<
<

Usage: (5.3.2 or later)

>
>

Usage: (Option 2, 5.3.2 or later only)

 
      PASS         <read_buffer>              FIELD            SHARE? Y
      PASS         <stream_name>              FIELD            SHARE? N
      PASS         <read_length>              FIELD            SHARE? N

Line: 32 to 32
  <stream_name> is the name of the previously opened stream (Required).
Changed:
<
<
<read_length> is the number of bytes to read (optional). If not passed it will read up until a line termination character to a maximum of 32000 characters. If a value is passed it will read up to that number of characters or until a line termination character is encountered, whichever comes first. In Releases 5.3.1 and earlier, if passed shared, it will return the number of characters actually read, however, you should set it back to 32000 before the next GOSUB --- .STREAM READ, otherwise this subroutine will only read that number of characters. In Release 5.3.2 and higher, this will value not return anything and will not change, even if passed SHARED.
>
>
<read_length> is the number of bytes to read (optional). If not passed it will read up until a line termination character to a maximum of 32000 characters. If a value is passed it will read up to that number of characters or until a line termination character is encountered, whichever comes first. In Option 1, if passed shared, it will return the number of characters actually read, however, you should set it back to 32000 before the next GOSUB --- .STREAM READ, otherwise this subroutine will only read that number of characters (or less). If you PASS <length_read> as in Option 2, this will value not return anything and will not change, even if passed SHARED. In this case, the number of bytes read will be returned in <length_read>.
  <length_read> is the number of characters actually read (5.3.2 and higher only). This must be passed SHARED to return a value.
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2021 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback