stream-set-write-buffer.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c3067ab0a7f55632c87da73368fd3c739e110a57 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.stream-set-write-buffer" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>stream_set_write_buffer</refname>
  <refpurpose>Configure le buffer d'écriture d'un flux</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>stream_set_write_buffer</methodname>
   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
   <methodparam><type>int</type><parameter>size</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>stream_set_write_buffer</function> configure le buffer d'écriture
   du flux <parameter>stream</parameter> à la taille de 
   <parameter>size</parameter> octets.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter></term>
     <listitem>
      <para>
       Le pointeur de fichier.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>size</parameter></term>
     <listitem>
      <para>
       Le nombre d'octets à mettre en buffer. Si <parameter>size</parameter>
       vaut 0 alors les opérations sont sans buffer. Cela garantit que les opérations
       avec <function>fwrite</function> sont achevées avant que d'autres processus
       ne soient autorisés à écrire dans le flux de sortie.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne 0 en cas de succès, ou un autre valeur si la requête échoue.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>stream_set_write_buffer</function></title>
    <para>
     L'exemple ci-dessous illustre l'utilisation de 
     <function>stream_set_write_buffer</function> pour créer un flux non
     bufferisé.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$fp = fopen($file, "w");
if ($fp) {
  if (stream_set_write_buffer($fp, 0) !== 0) {
      // la modification du buffer a échoué
  }
  fwrite($fp, $output);
  fclose($fp);
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
   
 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>fopen</function></member>
   <member><function>fwrite</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
-->