<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: aa120f36c5762e99f9ee121d8caf910e0a67121e Maintainer: hirokawa Status: ready -->

<!-- CREDITS: shimooka -->

<refentry xml:id="function.readgzfile" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>readgzfile</refname>

<refpurpose>gz ファイルを出力する</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>int</type><type>false</type></type><methodname>readgzfile</methodname>

<methodparam><type>string</type><parameter>filename</parameter></methodparam>

<methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter><initializer>&false;</initializer></methodparam>

</methodsynopsis>

<para>

ファイルを読み込み、解凍し、標準出力に書き込みます。

</para>

<para>

<function>readgzfile</function>は、gzip

フォーマットでないファイルの読込にも使用可能です。この場合、

<function>readgzfile</function> はファイルを解凍せずに直接読込みます。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>filename</parameter></term>

<listitem>

<para>

ファイル名を指定します。このファイルはファイルシステムからオープンされ、

内容は標準出力に書き込まれます。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>use_include_path</parameter></term>

<listitem>

<simpara>

&true; に設定すると、

どのファイルをオープンするかを決めるために

<link linkend="ini.include-path">include_path</link>

を使います。

</simpara>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

成功時は、ファイルから読み込んだ (解凍された) データのバイト数を返します。

&return.falseforfailure;

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

&fs.emits.warning.on.failure;

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.5.0</entry>

<entry>

<parameter>use_include_path</parameter> の型が <type>bool</type> になりました。

これより前は、<type>int</type> でした。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>gzpassthru</function></member>

<member><function>gzfile</function></member>

<member><function>gzopen</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

-->