inflate_add.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 02ba67b51f2bde571b6ce07026e935f4e81019af Maintainer: mumumu Status: ready -->

<refentry xml:id="function.inflate-add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>inflate_add</refname>
  <refpurpose>インクリメンタルにエンコードされたデータを解凍する</refpurpose>
 </refnamediv>

 <refsect1 role="description"><!-- {{{ -->
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>inflate_add</methodname>
   <methodparam><type>InflateContext</type><parameter>context</parameter></methodparam>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flush_mode</parameter><initializer><constant>ZLIB_SYNC_FLUSH</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   指定された <parameter>context</parameter> でエンコードされたデータをインクリメンタルに解凍します。
  </para>
  <para>
   制限: GZIP 圧縮されたデータからは、ヘッダ情報は利用できません。
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="parameters"><!-- {{{ -->
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>context</parameter></term>
    <listitem>
     <para>
      <function>inflate_init</function> で作られたコンテクスト
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>data</parameter></term>
    <listitem>
     <para>
      圧縮されたデータのチャンク
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>flush_mode</parameter></term>
    <listitem>
     <para>
      <constant>ZLIB_BLOCK</constant>,
      <constant>ZLIB_NO_FLUSH</constant>,
      <constant>ZLIB_PARTIAL_FLUSH</constant>,
      <constant>ZLIB_SYNC_FLUSH</constant> (デフォルト),
      <constant>ZLIB_FULL_FLUSH</constant>, <constant>ZLIB_FINISH</constant> のいずれか。
      通常は、圧縮率を最大にするために、 <constant>ZLIB_NO_FLUSH</constant> を指定するでしょうし、
      データの最後のチャンクで終了させるために <constant>ZLIB_FINISH</constant> を指定するでしょう。
      これらの定数の詳細な説明は <link
      xlink:href="http://www.zlib.net/manual.html">zlib manual</link> を参照ください。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1><!-- }}} -->

 <refsect1 role="returnvalues"><!-- {{{ -->
  &reftitle.returnvalues;
  <para>
   解凍されたデータのチャンクを返します。
   &return.falseforfailure;
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="errors"><!-- {{{ -->
  &reftitle.errors;
  <para>
   不正な引数が与えられた場合、データの解凍にはあらかじめ設定された辞書が必要なのに
   何も指定されなかった場合、圧縮データが壊れていたり、不正なチェックサムだった場合、
   エラーレベル <constant>E_WARNING</constant> が生成されます。
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>context</parameter> は、
       <classname>InflateContext</classname>
       クラスのインスタンスを期待するようになりました。
       これより前のバージョンでは、<type>resource</type> を期待していました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso"><!-- {{{ -->
  &reftitle.seealso;
  <simplelist>
   <member><function>inflate_init</function></member>
  </simplelist>
 </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
-->