mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
5b9fc29465
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
67 lines
2.1 KiB
XML
67 lines
2.1 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<!-- splitted from ./en/functions/zlib.xml, last change in rev 1.2 -->
|
|
<refentry id="function.readgzfile">
|
|
<refnamediv>
|
|
<refname>readgzfile</refname>
|
|
<refpurpose>Output a gz-file</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>readgzfile</methodname>
|
|
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Reads a file, decompresses it and writes it to standard
|
|
output.
|
|
</para>
|
|
<para>
|
|
<function>readgzfile</function> can be used to read a file which
|
|
is not in gzip format; in this case
|
|
<function>readgzfile</function> will directly read from the file
|
|
without decompression.
|
|
</para>
|
|
<para>
|
|
Returns the number of (uncompressed) bytes read from the file. If
|
|
an error occurs, &false; is returned and unless the function was
|
|
called as <literal>@readgzfile</literal>, an error message is
|
|
printed.
|
|
</para>
|
|
<para>
|
|
The file <parameter>filename</parameter> will be opened from the
|
|
filesystem and its contents written to standard output.
|
|
</para>
|
|
<para>
|
|
You can use the optional second parameter and set it to "1", if
|
|
you want to search for the file in the <link
|
|
linkend="ini.include-path">include_path</link>, too.
|
|
</para>
|
|
<para>
|
|
See also <function>gzpassthru</function>,
|
|
<function>gzfile</function>, and <function>gzopen</function>.
|
|
</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:"../../../../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
|
|
-->
|