<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.streamwrapper.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'streamwrapper.stream-seek.php',
    1 => 'streamWrapper::stream_seek',
    2 => 'Перемещает положение файлового указателя в потоке',
  ),
  'up' => 
  array (
    0 => 'class.streamwrapper.php',
    1 => 'streamWrapper',
  ),
  'prev' => 
  array (
    0 => 'streamwrapper.stream-read.php',
    1 => 'streamWrapper::stream_read',
  ),
  'next' => 
  array (
    0 => 'streamwrapper.stream-set-option.php',
    1 => 'streamWrapper::stream_set_option',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/stream/streamwrapper/stream-seek.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="streamwrapper.stream-seek" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">streamWrapper::stream_seek</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.3.2, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">streamWrapper::stream_seek</span> &mdash; <span class="dc-title">Перемещает положение файлового указателя в потоке</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-streamwrapper.stream-seek-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>streamWrapper::stream_seek</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$offset</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$whence</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   Метод вызывается в ответ на функцию <span class="function"><a href="function.fseek.php" class="function">fseek()</a></span>.
  </p>
  <p class="para">
   Позиция потока, с которой данные начнут считываться или записываться в поток,
   обновляется с учётом смещения <code class="parameter">offset</code>
   и значения параметра <code class="parameter">whence</code>, от которого отсчитывается смещение.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-streamwrapper.stream-seek-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">offset</code></dt>
     <dd>
      <p class="para">
       Смещение в потоке, на которое переместится указатель.
      </p>
     </dd>
    
    
     <dt><code class="parameter">whence</code></dt>
     <dd>
      <p class="para">
       Доступные значения:
       <ul class="simplelist">
        <li>
         <strong><code><a href="filesystem.constants.php#constant.seek-set">SEEK_SET</a></code></strong> — Перемещает указатель в положение,
         равное количеству байтов смещения <code class="parameter">offset</code> от начала файла.
        </li>
        <li>
         <strong><code><a href="filesystem.constants.php#constant.seek-cur">SEEK_CUR</a></code></strong> — Перемещает указатель вперёд — в положение,
         равное количеству байтов смещения <code class="parameter">offset</code> от текущей позиции.
        </li>
        <li>
         <strong><code><a href="filesystem.constants.php#constant.seek-end">SEEK_END</a></code></strong> — Перемещает указатель за пределы конца файла — в положение,
         равное количеству байтов смещения <code class="parameter">offset</code> от конца файла.
        </li>
       </ul>
      </p>
      <blockquote class="note"><p><strong class="note">Замечание</strong>: 
       <span class="simpara">
        Текущая реализация метода не устанавливает для параметра <code class="parameter">whence</code>
        значение <strong><code><a href="filesystem.constants.php#constant.seek-cur">SEEK_CUR</a></code></strong>; вместо перемещения указателя от текущей позиции
        перемещение внутренне преобразовывается в режим <strong><code><a href="filesystem.constants.php#constant.seek-set">SEEK_SET</a></code></strong>.
       </span>
      </p></blockquote>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-streamwrapper.stream-seek-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Метод возвращает значение <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>, если обновил позицию указателя, иначе возвращает значение <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-streamwrapper.stream-seek-notes">
  <h3 class="title">Примечания</h3>
  <blockquote class="note"><p><strong class="note">Замечание</strong>: 
   <p class="para">
    Значение <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> предполагается как значение возврата, если метод не реализовали.
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Замечание</strong>: 
   <p class="para">
    Сразу после успешного вызова
    метода <span class="methodname"><strong>streamWrapper::stream_seek()</strong></span>
    вызывается метод <span class="methodname"><a href="streamwrapper.stream-tell.php" class="methodname">streamWrapper::stream_tell()</a></span>.
    Значение <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> устанавливается как значение возврата функции,
    которая вызвала этот метод, если метод <span class="methodname"><a href="streamwrapper.stream-tell.php" class="methodname">streamWrapper::stream_tell()</a></span>
    завершится ошибкой.
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Замечание</strong>: 
   <p class="para">
    Не каждая операция перемещения указателя в потоке вызывает этот метод.
    PHP-потоки по умолчанию буферизируют считывание (смотрите также
    описание функции <span class="function"><a href="function.stream-set-read-buffer.php" class="function">stream_set_read_buffer()</a></span>),
    поэтому перемещение указателя иногда завершается простым перемещением
    указателя буфера.
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-streamwrapper.stream-seek-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.fseek.php" class="function" rel="rdfs-seeAlso">fseek()</a> - Перемещает позицию файлового указателя</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>