zip-entry-read.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 -->
<refentry xml:id="function.zip-entry-read" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>zip_entry_read</refname>
  <refpurpose>Read from an open directory entry</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
   &warn.deprecated.function-8-0-0;
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier role="attribute">#[\Deprecated]</modifier>
   <type class="union"><type>string</type><type>false</type></type><methodname>zip_entry_read</methodname>
   <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>len</parameter><initializer>1024</initializer></methodparam>
  </methodsynopsis>
  <para>
   Reads from an open directory entry.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>zip_entry</parameter></term>
     <listitem>
      <para>
       A directory entry returned by <function>zip_read</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>len</parameter></term>
     <listitem>
      <para>
       The number of bytes to return.
      </para>
      <note>
       <para>
        This should be the uncompressed length you wish to read.
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the data read, empty string on end of a file, or &false; on error.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.0.0</entry>
       <entry>
        This function is deprecated in favor of the Object API,
        see <methodname>ZipArchive::getFromIndex</methodname>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>zip_entry_open</function></member>
    <member><function>zip_entry_close</function></member>
    <member><function>zip_entry_filesize</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
-->