php-doc-en/reference/zip/functions/zip-entry-read.xml
Hartmut Holzgraefe 5b9fc29465 revision tags added
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
2002-04-17 06:45:35 +00:00

61 lines
1.9 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 -->
<refentry id="function.zip-entry-read">
<refnamediv>
<refname>zip_entry_read</refname>
<refpurpose>Read From an Open Directory Entry</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>zip_entry_read</methodname>
<methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
Reads up to <parameter>length</parameter> bytes from an open
directory entry. If <parameter>length</parameter> is not
specified, then <function>zip_entry_read</function> will attempt
to read 1024 bytes. The parameter
<parameter>zip_entry</parameter> is a valid directory entry
returned by <function>zip_read</function>.
</para>
<note>
<para>
The <parameter>length</parameter> parameter should be the
uncompressed length you wish to read.
</para>
</note>
<para>
Returns the data read, or &false; if the end of the file is
reached.
</para>
<para>
See also <function>zip_entry_open</function>,
<function>zip_entry_close</function> and
<function>zip_entry_filesize</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
-->