fpassthru.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: seros Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fpassthru">
 <refnamediv>
  <refname>fpassthru</refname>
  <refpurpose>Escribe toda la información restante de un puntero a un archivo</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>fpassthru</methodname>
   <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
  </methodsynopsis>
  <para>
   Lee hasta EOF en el puntero al archivo dado desde la posición actual y
   escribe los resultados en el buffer de salida.
  </para>
  <para>
   Puede necesitar llamar a <function>rewind</function> para reiniciar el puntero
   al archivo al principio del archivo si ya se ha escrito información
   en el archivo.
  </para>
  <para>
   Si sólo quiere verter los contenidos de un archivo en el buffer de salida,
   sin modificarlo primero o buscar un índice en particular, puede
   usar la función <function>readfile</function>, la cual le libera de
   llamar a <function>fopen</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>handle</parameter></term>
     <listitem>
      &fs.validfp.all;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Si se produjo un error, <function>fpassthru</function> devuelve
   &false;. De otro modo, <function>fpassthru</function> devuelve
   el número de caracteres leídos desde <parameter>handle</parameter>
   y pasados hacia la salida.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Usar <function>fpassthru</function> con archivos binarios</title>
    <programlisting role="php">
<![CDATA[
<?php

// abre el archivo en modo binario
$nombre = './img/ok.png';
$fp = fopen($nombre, 'rb');

// envía las cabeceras correctas
header("Content-Type: image/png");
header("Content-Length: " . filesize($nombre));

// vuelca la imagen y detiene el script
fpassthru($fp);
exit;

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Cuando se usa <function>fpassthru</function> sobre un archivo binario en sistemas
    Windows, debería asegurarse de abrir el archivo en modo binario
    añadiendo <literal>b</literal> al modo usado en la llamada a
    <function>fopen</function>.
   </para>
   <para>
    Se le anima a usar la bandera <literal>b</literal> cuando trata
    con archivos binarios, incluso si su sistema no lo requiere, por lo que
    sus scripts serán más portables.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>readfile</function></member>
    <member><function>fopen</function></member>
    <member><function>popen</function></member>
    <member><function>fsockopen</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
-->