eio-seek.xml

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

<refentry xml:id="function.eio-seek" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>eio_seek</refname>
  <refpurpose><parameter>fd</parameter> で指定したファイル内でのオフセットを、<parameter>offset</parameter> と <parameter>whence</parameter> に従って移動する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>eio_seek</methodname>
   <methodparam><type>mixed</type><parameter>fd</parameter></methodparam>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam><type>int</type><parameter>whence</parameter></methodparam>
   <methodparam
   choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
   <methodparam
   choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
   <methodparam
   choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>eio_seek</function> は、<parameter>fd</parameter>
   で指定したファイル内でのオフセットを、<parameter>offset</parameter> と
   <parameter>whence</parameter> で指定した位置に移動します。<parameter>whence</parameter> の意味は次のとおりです。
   <simplelist>
    <member><constant>EIO_SEEK_SET</constant> - 戦闘から <parameter>offset</parameter> バイトの位置に移動する。</member>
    <member><constant>EIO_SEEK_CUR</constant> - 現在の位置から <parameter>offset</parameter> バイト進める。</member>
    <member><constant>EIO_SEEK_END</constant> - ファイルの末尾から <parameter>offset</parameter> バイト進める。</member>
   </simplelist>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>fd</parameter></term>
    <listitem>
     <para>
     ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>offset</parameter></term>
    <listitem>
     <para>
     読み込みの開始位置。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>length</parameter></term>
    <listitem>
     <para>
     読み込むバイト数。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>pri</parameter></term>
    <listitem>
    &eio.request.pri.values;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>callback</parameter></term>
    <listitem>
     &eio.callback.proto;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>data</parameter></term>
    <listitem>
     <para>
     <parameter>callback</parameter> に渡す任意の引数。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>eio_seek</function>
   は、成功した場合にリクエストリソースを返します。&return.falseforfailure;
  </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
-->