svn: /phpdoc/en/trunk/reference/stream/ functions/stream-set-read-buffer.xml functions/stream-set-write-buffer.xml versions.xml

From: Date: Tue, 01 Jun 2010 20:22:45 +0000
Subject: svn: /phpdoc/en/trunk/reference/stream/ functions/stream-set-read-buffer.xml functions/stream-set-write-buffer.xml versions.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-6774@lists.php.net to get a copy of this message
philip Tue, 01 Jun 2010 20:22:45 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=300073 Log: Documented stream_set_read_buffer() Changed paths: A phpdoc/en/trunk/reference/stream/functions/stream-set-read-buffer.xml U phpdoc/en/trunk/reference/stream/functions/stream-set-write-buffer.xml U phpdoc/en/trunk/reference/stream/versions.xml Added: phpdoc/en/trunk/reference/stream/functions/stream-set-read-buffer.xml =================================================================== --- phpdoc/en/trunk/reference/stream/functions/stream-set-read-buffer.xml (rev 0) +++ phpdoc/en/trunk/reference/stream/functions/stream-set-read-buffer.xml 2010-06-01 20:22:45 UTC (rev 300073) @@ -0,0 +1,81 @@ +<?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 write to that output stream. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns 0 on success, or <acronym>EOF</acronym> 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 +--> Property changes on: phpdoc/en/trunk/reference/stream/functions/stream-set-read-buffer.xml ___________________________________________________________________ Added: svn:keywords + Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL Added: svn:eol-style + native Modified: phpdoc/en/trunk/reference/stream/functions/stream-set-write-buffer.xml =================================================================== --- phpdoc/en/trunk/reference/stream/functions/stream-set-write-buffer.xml 2010-06-01 20:00:51 UTC (rev 300072) +++ phpdoc/en/trunk/reference/stream/functions/stream-set-write-buffer.xml 2010-06-01 20:22:45 UTC (rev 300073) @@ -4,7 +4,7 @@ <refentry xml:id="function.stream-set-write-buffer" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>stream_set_write_buffer</refname> - <refpurpose>Sets file buffering on the given stream</refpurpose> + <refpurpose>Sets write file buffering on the given stream</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; Modified: phpdoc/en/trunk/reference/stream/versions.xml =================================================================== --- phpdoc/en/trunk/reference/stream/versions.xml 2010-06-01 20:00:51 UTC (rev 300072) +++ phpdoc/en/trunk/reference/stream/versions.xml 2010-06-01 20:22:45 UTC (rev 300073) @@ -38,6 +38,7 @@ <function name='stream_set_blocking' from='PHP 4 &gt;= 4.3.0, PHP 5'/> <function name='stream_set_timeout' from='PHP 4 &gt;= 4.3.0, PHP 5'/> <function name='stream_set_write_buffer' from='PHP 4 &gt;= 4.3.0, PHP 5'/> + <function name='stream_set_read_buffer' from='PHP 5 &gt;= 5.3.3'/> <function name='stream_socket_accept' from='PHP 5'/> <function name='stream_socket_client' from='PHP 5'/> <function name='stream_socket_enable_crypto' from='PHP 5 &gt;= 5.1.0'/>

« previous php.doc.cvs (#6774) next »