gzseek.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 02ba67b51f2bde571b6ce07026e935f4e81019af Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka -->
<refentry xml:id="function.gzseek" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>gzseek</refname>
  <refpurpose>gz ファイルポインタの位置を移動する</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>gzseek</methodname>
   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>whence</parameter><initializer><constant>SEEK_SET</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   与えられたファイルポインタが指すファイルのファイル位置記述子を、
   ファイルストリーム上の与えられた
   offset バイトにセットします。
   <literal>gzseek(zp, offset, SEEK_SET)</literal> を
   (C 言語において) コールするのと同じです。
  </para>
  <para>
   ファイルが読み込み用にオープンされた場合、この関数は、
   エミュレーションされますが、極端に遅くなる可能性があります。
   ファイルを書き込み用にオープンした場合、
   前方への移動のみがサポートされます。この場合、<function>gzseek</function>
   は、新しい開始位置までゼロの並びのデータを圧縮します。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter></term>
     <listitem>
      <para>
       gz ファイルポインタを指定します。これは有効なファイルポインタであり、
       かつ、<function>gzopen</function>
       によりオープンできたファイルを指している必要があります。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       移動するオフセットを指定します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>whence</parameter></term>
     <listitem>
      <para>
       <parameter>whence</parameter> の値は次のいずれかです。
       <simplelist>
        <member><constant>SEEK_SET</constant> - <parameter>offset</parameter> バイト目に設定します。</member>
        <member><constant>SEEK_CUR</constant> - 現在位置から <parameter>offset</parameter> ぶん進んだ位置に設定します。</member>
       </simplelist>
      </para>
      <para>
       <parameter>whence</parameter> を省略した場合は
       <constant>SEEK_SET</constant> とみなします。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合、0を返します。それ以外の場合は、-1を返します。
   移動がEOFを超える場合にもエラーは発生しないことに注意してください。
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>gzseek</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$gz = gzopen('somefile.gz', 'r');
gzseek($gz,2);
echo gzgetc($gz);
gzclose($gz);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>gztell</function></member>
    <member><function>gzrewind</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
-->