gzinflate.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b9d23bbb94e5e0b71c3f4a8c12f3671f64516370 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.gzinflate" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>gzinflate</refname>
  <refpurpose>Décompresse une chaîne</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>gzinflate</methodname>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>max_length</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>gzinflate</function> décompresse une chaîne.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       Les données compressées avec la fonction <function>gzdeflate</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>max_length</parameter></term>
     <listitem>
      <para>
       La longueur maximale de données décodé.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Les données originales décompressées ou &false; si une erreur survient.
  </para>
  <para>
   <function>gzinflate</function> retourne une erreur si la chaîne décompressée
   est plus de 32768 fois plus longue que la chaîne compressée
   <parameter>data</parameter> ou, sauf si <parameter>max_length</parameter>
   est <literal>0</literal>, plus grande que la taille de
   <parameter>max_length</parameter> octets, passé comme paramètre optionnel.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>gzinflate</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$compressed   = gzdeflate('Compresse moi', 9);
$uncompressed = gzinflate($compressed);
echo $uncompressed;
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>gzdeflate</function></member>
    <member><function>gzcompress</function></member>
    <member><function>gzuncompress</function></member>
    <member><function>gzencode</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
-->