gzpassthru.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 15352977cfdac48a100c50b85674b8e31b8d0abc Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka -->
<refentry xml:id="function.gzpassthru" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>gzpassthru</refname>
  <refpurpose>
   gzファイルへのポインタから残りのデータ全部を出力する
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>gzpassthru</methodname>
   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
  </methodsynopsis>
  <para>
   gz ファイルポインタについて現在位置から <acronym>EOF</acronym> までデータを読み込み、
   標準出力に (伸長された) 結果を書き込みます。
  </para>
  <note>
   <para>
    すでにデータをファイルに書き込んでいる場合、
    ファイルポインタをファイルの先頭にセットするために
    <function>gzrewind</function> をコールする必要があるかも知れません。
   </para>
  </note>
  <tip>
   <para>
    修正や特定のオフセットへの移動なしに
    ファイルの内容を出力バッファにダンプしたいだけの場合、
    <function>readgzfile</function> 関数を使用することもできます。
    これにより、<function>gzopen</function>
    をコールする手間を省くことができます。
   </para>
  </tip>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter></term>
     <listitem>
      <para>
       gz ファイルポインタを指定します。これは有効なファイルポインタであり、
       かつ、<function>gzopen</function>
       によりオープンできたファイルを指している必要があります。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>gz</parameter> から読み込んで解凍され、入力に渡された文字数。
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>gzpassthru</function> の例</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
-->