archived-doc-ru/reference/spl/splfileobject/fseek.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="splfileobject.fseek" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SplFileObject::fseek</refname>
  <refpurpose>Перемещает положение файлового указателя</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="SplFileObject">
   <modifier>public</modifier> <type>int</type><methodname>SplFileObject::fseek</methodname>
   <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>
   Метод перемещает положение указателя в файле на позицию,
   которую получает путём добавления смещения <parameter>offset</parameter>
   к положению, которое указали в параметре <parameter>whence</parameter>.
   Положение измеряется в байтах от начала файла.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       Смещение. Отрицательные значения указывают
       для перемещения назад по файлу, что полезно, когда флаг SEEK_END указывают
       как значение параметра <parameter>whence</parameter>.
      </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>
        <member>
         <constant>SEEK_END</constant> — Перемещает указатель в положение,
         равное количеству байтов смещения <parameter>offset</parameter> от конца файла.
        </member>
       </simplelist>
      </para>
      <para>
       Метод будет работать в режиме <constant>SEEK_SET</constant>,
       если параметр <parameter>whence</parameter> не указали.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Метод возвращает 0 при успешном перемещении, иначе -1. Обратите внимание,
   что метод не считает ошибкой перемещение за пределы файла.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования метода <methodname>SplFileObject::fseek</methodname></title>
    <programlisting role="php">
<![CDATA[
<?php

$file = new SplFileObject("somefile.txt");

// Считываем первую строку
$data = $file->fgets();

// Перемещаемся в начало файла
// То же, что и вызов метода $file->rewind();
$file->fseek(0);

?>
]]>
    </programlisting>
   </example>
  </para>
 </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
-->