stream-copy-to-stream.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 604ce6e4e62c8ed349f98a305d90a38b717cc081 Maintainer: seros Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.stream-copy-to-stream" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>stream_copy_to_stream</refname>
  <refpurpose>Copia información desde un flujo a otro</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><initializer>-1</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Hace una copia de hasta <parameter>maxlength</parameter> bytes
   de información desde la posición actual (o desde la posición de
   <parameter>offset</parameter>, si se especifica) desde
   <parameter>source</parameter> a <parameter>dest</parameter>. Si
   no se especifica <parameter>maxlength</parameter>, todo el contenido restante de
   <parameter>source</parameter> será copiado.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>source</parameter></term>
     <listitem>
      <para>
       El flujo de origen
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dest</parameter></term>
     <listitem>
      <para>
       El flujo de destino
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>maxlength</parameter></term>
     <listitem>
      <para>
       Máximos bytes a copiar
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       El índice donde comenzar a copiar información
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve el número total de bytes copiados, &return.falseforfailure;.
  </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>
        Se añadió el parámetro <parameter>offset</parameter>
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Un ejemplo de <function>stream_copy_to_stream</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$origen   = fopen('http://www.example.com', 'r');
$destino1 = fopen('primer1k.txt', 'w');
$destino2 = fopen('resto.txt', 'w');

echo stream_copy_to_stream($origen, $destino1, 1024) . " bytes copiados a primer1k.txt\n";
echo stream_copy_to_stream($origen, $destino2) . " bytes copiados a resto.txt\n";

?>
]]>
    </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:
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
-->