0LASubrStreamWrite < Main

Tags: view all tags
---+ .STREAM WRITE

_This subroutine is called to write data to a file stream._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;write_buffer&gt;             FIELD            SHARE? N
      PASS         &lt;stream_name&gt;              FIELD            SHARE? N
      PASS         &lt;binary_write_length&gt;      FIELD            SHARE? N
      GOSUB    --- .STREAM WRITE
      *        check for errors
      IF       --- .STREAM WRITE              NE

</pre>
---++ Description:

This subroutine is called to write data to a file stream previously opened for WRITE or APPEND access via [[0LASubrStreamOpen][.STREAM OPEN]].

The first two parameters are required, and the subroutine will CANCEL if they are are not all received.

&lt;write_buffer&gt; contains the data to be written (Required). This subroutine can write lines up to a maximum of 32000 characters. The &lt;line_termination&gt; character you specified when you opened the file will automatically be appended to your data.

&lt;stream_name&gt; is the name of the previously opened stream (Required).

&lt;binary_write_length&gt; is an optional parameter and is only applicable if the file was opened in binary mode (5.4.4 & up). If the file is opened in binary mode and this parameter is not passed, it will default to the length of &lt;write buffer&gt;. The &lt;write_buffer&gt; field will be padded with spaces if necessary. If the length of &lt;write_buffer&gt; is greater than 32000, only the first 32000 bytes will be written. If &lt;binary_write_length&gt; is larger than the size of &lt;write_buffer&gt; then the actual length of &lt;write_buffer&gt; will be used.
---++ Comments:

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

<br />%COMMENT%

-- Main.JeanNeron - 2012-01-24
Topic revision: r5 - 2016-03-02 - JeanNeron