archived-doc-ja/reference/stream/streamwrapper/stream-seek.xml

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

<refentry xml:id="streamwrapper.stream-seek" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>streamWrapper::stream_seek</refname>
  <refpurpose>ストリーム内の特定の場所に移動する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>streamWrapper::stream_seek</methodname>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam><type>int</type><parameter>whence</parameter></methodparam>
  </methodsynopsis>
  <para>
   このメソッドは、<function>fseek</function> に対応してコールされます。
  </para>
  <para>
   ストリームの読み込み/書き込み位置を、
   <parameter>offset</parameter> と <parameter>whence</parameter>
   に応じて更新しなければなりません。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       移動するストリームオフセット。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>whence</parameter></term>
     <listitem>
      <para>
       使用可能な値
       <simplelist>
        <member><constant>SEEK_SET</constant> - <parameter>offset</parameter> バイト目の位置に移動する。</member>
        <member><constant>SEEK_CUR</constant> - 現在位置から <parameter>offset</parameter> バイトぶん進める。</member>
        <member><constant>SEEK_END</constant> - ファイルの終端から <parameter>offset</parameter> バイトぶん進める。</member>
       </simplelist>
      </para>
      <note>
       <simpara>
        現在の実装は、
        <parameter>whence</parameter> の値を <constant>SEEK_CUR</constant> に設定することはありません。
        そのようなシークは、
        内部的に <constant>SEEK_SET</constant> と同じ動きに変換されます。
       </simpara>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   位置を更新した場合に &true;、それ以外の場合に &false; を返します。
  </para>
 </refsect1>

<!--
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>streamWrapper::stream_seek</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
...
]]>
    </screen>
   </example>
  </para>
 </refsect1>
-->

 <refsect1 role="notes"><!-- {{{ -->
  &reftitle.notes;
  <note>
   <para>
    実装されていないの戻り値は &false; とみなされます。
   </para>
  </note>
  <note>
   <para>
    成功した場合、
    <methodname>streamWrapper::stream_seek</methodname> をコールした直後に
    <methodname>streamWrapper::stream_tell</methodname> がコールされます。
    <methodname>streamWrapper::stream_tell</methodname> が失敗すると、
    呼び出し元関数への戻り値は &false; に設定されます。
   </para>
  </note>
  <note>
   <para>
    ストリーム上でシーク操作をしたときに、必ずこの関数がコールされるとは限りません。
    PHP のストリームはバッファ付きの読み込みがデフォルトで有効になっている
    (<function>stream_set_read_buffer</function> も参照ください)
    ので、シーク操作が単なるバッファポインタの移動だけで済む場合があります。
   </para>
  </note>
 </refsect1><!-- }}} -->

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