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

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: cf2b279980fc54b7f2602a0687652c170a906930 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<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="notes"><!-- {{{ -->
  &reftitle.notes;
  <note>
   <para>
    Значение &false; предполагается как значение возврата, если метод не реализовали.
   </para>
  </note>
  <note>
   <para>
    Сразу после успешного вызова
    метода <methodname>streamWrapper::stream_seek</methodname>
    вызывается метод <methodname>streamWrapper::stream_tell</methodname>.
    Значение &false; устанавливается как значение возврата функции,
    которая вызвала этот метод, если метод <methodname>streamWrapper::stream_tell</methodname>
    завершится ошибкой.
   </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
-->