stream-set-read-buffer.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.stream-set-read-buffer" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>stream_set_read_buffer</refname>
  <refpurpose>Set read file buffering on the given stream</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>stream_set_read_buffer</methodname>
   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
   <methodparam><type>int</type><parameter>buffer</parameter></methodparam>
  </methodsynopsis>
  <para>
   Sets the read buffer. It's the equivalent of <function>stream_set_write_buffer</function>,
   but for read operations.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>stream</parameter></term>
    <listitem>
     <para>
      The file pointer.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>buffer</parameter></term>
    <listitem>
     <para>
      The number of bytes to buffer. If <parameter>buffer</parameter>
      is 0 then read operations are unbuffered.  This ensures that all reads
      with <function>fread</function> are completed before other processes are
      allowed to read from that input stream.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns 0 on success, or another value if the request
   cannot be honored.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>stream_set_write_buffer</function></member>
  </simplelist>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->