From 7d41b387c34870483fcfb467985e23aac0b68176 Mon Sep 17 00:00:00 2001
From: Philip Olson <philip@php.net>
Date: Fri, 2 Mar 2012 03:34:03 +0000
Subject: [PATCH] Added documentation for stream_set_chunk_size()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@323776 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../functions/stream-set-chunk-size.xml       | 84 +++++++++++++++++++
 1 file changed, 84 insertions(+)
 create mode 100644 reference/stream/functions/stream-set-chunk-size.xml

diff --git a/reference/stream/functions/stream-set-chunk-size.xml b/reference/stream/functions/stream-set-chunk-size.xml
new file mode 100644
index 0000000000..7e8a794ee9
--- /dev/null
+++ b/reference/stream/functions/stream-set-chunk-size.xml
@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="function.stream-set-chunk-size" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>stream_set_chunk_size</refname>
+  <refpurpose>Set the stream chunk size</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>int</type><methodname>stream_set_chunk_size</methodname>
+   <methodparam><type>resource</type><parameter>fp</parameter></methodparam>
+   <methodparam><type>int</type><parameter>chunk_size</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Set the stream chunk size.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>fp</parameter></term>
+    <listitem>
+     <para>
+      The target stream.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>chunk_size</parameter></term>
+    <listitem>
+     <para>
+      The desired new chunk size.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the previous chunk size on success.
+  </para>
+  <para>
+   Will return &false; if <parameter>chunk_size</parameter> is less than 1 or
+   greater than <constant>PHP_INT_MAX</constant>.
+  </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Will emit an <constant>E_WARNING</constant> level error if <parameter>chunk_size</parameter>
+   is less than 1 or greater than <constant>PHP_INT_MAX</constant>.
+  </para>
+ </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
+-->