stream-set-write-buffer.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c3067ab0a7f55632c87da73368fd3c739e110a57 Maintainer: hirokawa Status: ready -->
<refentry xml:id="function.stream-set-write-buffer" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>stream_set_write_buffer</refname>
  <refpurpose>指定されたストリームのファイル書き込みバッファリングを有効にする</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>
   <parameter>stream</parameter>
   で指定されたファイルポインタに <parameter>size</parameter>
   で表されたバイト数分だけ出力バッファを設定します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter></term>
     <listitem>
      <para>
       ファイルポインタ。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>size</parameter></term>
     <listitem>
      <para>
       バッファのバイト数。
       <parameter>size</parameter> が 0 であれば、書き込み操作はバッファされなくなります。
       これにより、<function>fwrite</function> による書き込み操作が、他の
       プロセスが同じ出力ストリームに対して何らかの書き込み操作を行う前に
       完了することが保証されます。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功時に 0 を、要求通りに設定できなかった場合はそれ以外の値を返します。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>stream_set_write_buffer</function> の例</title>
    <para>
     次の例は、バッファされていないストリームを <function>stream_set_write_buffer</function>
     によって作成する方法を示したものです。
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$fp = fopen($file, "w");
if ($fp) {
  if (stream_set_write_buffer($fp, 0) !== 0) {
      // バッファリングの変更に失敗しました
  }
  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
-->