nlopess Wed Jun 22 15:18:32 2005 EDT
Modified files:
/phpdoc/en/reference/stream/functions stream-copy-to-stream.xml
Log:
upgrade to new style and document new 'offset' parameter
http://cvs.php.net/diff.php/phpdoc/en/reference/stream/functions/stream-copy-to-stream.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/stream/functions/stream-copy-to-stream.xml
diff -u phpdoc/en/reference/stream/functions/stream-copy-to-stream.xml:1.5
phpdoc/en/reference/stream/functions/stream-copy-to-stream.xml:1.6
--- phpdoc/en/reference/stream/functions/stream-copy-to-stream.xml:1.5 Mon Dec
15 11:53:49 2003
+++ phpdoc/en/reference/stream/functions/stream-copy-to-stream.xml Wed Jun
22 15:18:30 2005
@@ -1,27 +1,106 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
- <refentry id="function.stream-copy-to-stream">
- <refnamediv>
- <refname>stream_copy_to_stream</refname>
- <refpurpose>Copies data from one stream to another</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>stream_copy_to_stream</methodname>
-
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
-
<methodparam><type>resource</type><parameter>dest</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>maxlength</parameter></methodparam>
- </methodsynopsis>
- <para>
- Makes a copy of up to <parameter>maxlength</parameter> bytes
- of data from the current position in <parameter>source</parameter> to
- <parameter>dest</parameter>. If <parameter>maxlength</parameter>
- is not specified, all remaining content in <parameter>source</parameter>
- will be copied. Returns the total count of bytes copied.
- <example>
- <title><function>stream_copy_to_stream</function> example</title>
- <programlisting role="php">
+<!-- $Revision: 1.6 $ -->
+<refentry id="function.stream-copy-to-stream">
+ <refnamediv>
+ <refname>stream_copy_to_stream</refname>
+ <refpurpose>Copies data from one stream to another</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>int</type><methodname>stream_copy_to_stream</methodname>
+
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>dest</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>maxlength</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Makes a copy of up to <parameter>maxlength</parameter> bytes
+ of data from the current position (or from the
+ <parameter>offset</parameter> position, if specified) in
+ <parameter>source</parameter> to <parameter>dest</parameter>. If
+ <parameter>maxlength</parameter> is not specified, all remaining content in
+ <parameter>source</parameter> will be copied.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>source</parameter></term>
+ <listitem>
+ <para>
+ The source stream
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>dest</parameter></term>
+ <listitem>
+ <para>
+ The destination stream
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>maxlength</parameter></term>
+ <listitem>
+ <para>
+ Maximum bytes to copy
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>offset</parameter></term>
+ <listitem>
+ <para>
+ The offset where to start to copy data
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the total count of bytes copied.
+ </para>
+ </refsect1>
+
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>5.1.0</entry>
+ <entry>
+ Added the <parameter>offset</parameter>.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>A <function>stream_copy_to_stream</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$src = fopen('http://www.example.com', 'r');
@@ -33,14 +112,20 @@
?>
]]>
- </programlisting>
- </example>
- </para>
- <para>
- See also <function>copy</function>.
- </para>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>copy</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
