<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.gzpassthru" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>gzpassthru</refname>
  <refpurpose>
   Output all remaining data on a gz-file pointer
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>gzpassthru</methodname>
   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
  </methodsynopsis>
  <para>
   Reads to <acronym>EOF</acronym> on the given gz-file pointer from the current position and
   writes the (uncompressed) results to standard output.
  </para>
  <note>
   <para>
    You may need to call <function>gzrewind</function> to reset the file
    pointer to the beginning of the file if you have already written data 
    to it. 
   </para>
  </note>
  <tip>
   <para>
    If you just want to dump the contents of a file to the output buffer, 
    without first modifying it or seeking to a particular offset, you may 
    want to use the <function>readgzfile</function> function, which saves 
    you the <function>gzopen</function> call.
   </para>
  </tip>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter></term>
     <listitem>
      <para>
       The gz-file pointer. It must be valid, and must point to a file
       successfully opened by <function>gzopen</function>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The number of uncompressed characters read from <parameter>gz</parameter>
   and passed through to the input.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>gzpassthru</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$fp = gzopen('file.gz', 'r');
gzpassthru($fp);
gzclose($fp);
?>
]]>
    </programlisting>
   </example>
  </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
-->
