<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.filesystem.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.fseek.php',
    1 => 'fseek',
    2 => 'Aponta para uma posi&ccedil;&atilde;o no arquivo',
  ),
  'up' => 
  array (
    0 => 'ref.filesystem.php',
    1 => 'Fun&ccedil;&otilde;es de Filesystem',
  ),
  'prev' => 
  array (
    0 => 'function.fscanf.php',
    1 => 'fscanf',
  ),
  'next' => 
  array (
    0 => 'function.fstat.php',
    1 => 'fstat',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/filesystem/functions/fseek.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.fseek" class="refentry">
<div class="refnamediv">
 <h1 class="refname">fseek</h1>
 <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">fseek</span> &mdash; <span class="dc-title">Aponta para uma posição no arquivo</span></p>

</div>

<div class="refsect1 description" id="refsect1-function.fseek-description">
 <h3 class="title">Descrição</h3>
 <div class="methodsynopsis dc-description">
  <span class="methodname"><strong>fseek</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$stream</code></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 class="initializer"> = <strong><code><a href="filesystem.constants.php#constant.seek-set">SEEK_SET</a></code></strong></span></span>): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>

 <p class="para rdfs-comment">
  Modifica o indicador de posição do arquivo referenciado por
  <code class="parameter">stream</code>. A nova posição, medida em bytes a partir
  do início do arquivo, é obtida ao adicionar
  <code class="parameter">offset</code> à posição especificada por
  <code class="parameter">whence</code>.
 </p>
 <p class="para">
  Geralmente é permitido apontar para além do fim-do-arquivo; se algum dado for então
  escrito, leituras além de qualquer região escrita entre o fim-do-arquivo e a região desejada
  irão trazer bytes com valor 0. Entretanto, alguns fluxos
  podem não suportar esse comportamento, especialmente quando têm definido
  um tamanho de armazenamento fixo.
 </p>
</div>


<div class="refsect1 parameters" id="refsect1-function.fseek-parameters">
 <h3 class="title">Parâmetros</h3>
 <p class="para">
  <dl>
   
    <dt><code class="parameter">stream</code></dt>
    <dd>
     <p class="para">Um <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> de ponteiro do sistema de arquivos
que normalmente é criado usando <span class="function"><a href="function.fopen.php" class="function">fopen()</a></span>.</p>
    </dd>
   
   
    <dt><code class="parameter">offset</code></dt>
    <dd>
     <p class="para">
      A posição.
     </p>
     <p class="para">
      Para apontar para uma posição anterior ao fim-do-arquivo,
      um valor negativo em <code class="parameter">offset</code> deve ser passado
      e o parâmetro <code class="parameter">whence</code> deve ser definido
      para <strong><code><a href="filesystem.constants.php#constant.seek-end">SEEK_END</a></code></strong>.
     </p>
    </dd>
   
   
    <dt><code class="parameter">whence</code></dt>
    <dd>
     <p class="para">
      Valores de <code class="parameter">whence</code> são:
      <ul class="simplelist">
       <li><strong><code><a href="filesystem.constants.php#constant.seek-set">SEEK_SET</a></code></strong> - Define a posição igual ao número de bytes informado em <code class="parameter">offset</code> desde o início do arquivo.</li>
       <li><strong><code><a href="filesystem.constants.php#constant.seek-cur">SEEK_CUR</a></code></strong> - Define a posição para a localização atual mais o número de bytes informado em <code class="parameter">offset</code>.</li>
       <li><strong><code><a href="filesystem.constants.php#constant.seek-end">SEEK_END</a></code></strong> - Define a posição para o final do arquivo mais o número de bytes informado em <code class="parameter">offset</code>.</li>
      </ul>
     </p>
    </dd>
   
  </dl>
 </p>
</div>


<div class="refsect1 returnvalues" id="refsect1-function.fseek-returnvalues">
 <h3 class="title">Valor Retornado</h3>
 <p class="para">
  Em caso de sucesso, retorna  <code class="literal">0</code>;
  caso contrário, retorna <code class="literal">-1</code>.
 </p>
  <div class="warning"><strong class="warning">Aviso</strong>
   <p class="simpara">
    Esta função foi criada para imitar a função de mesmo nome da linguagem C.
    Atenção aos valores de retorno, pois eles diferem do
    esperado no PHP.
   </p>
  </div>
</div>


<div class="refsect1 examples" id="refsect1-function.fseek-examples">
 <h3 class="title">Exemplos</h3>
 <p class="para">
  <div class="example" id="example-1">
   <p><strong>Exemplo #1 Exemplo de <span class="function"><strong>fseek()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">'arquivo.txt'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// lê alguns dados<br /></span><span style="color: #0000BB">$data </span><span style="color: #007700">= </span><span style="color: #0000BB">fgets</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #0000BB">4096</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// move de volta para o inicio do arquivo<br />// o mesmo que rewind($fp);<br /></span><span style="color: #0000BB">fseek</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </p>
</div>


<div class="refsect1 notes" id="refsect1-function.fseek-notes">
 <h3 class="title">Notas</h3>
 <blockquote class="note"><p><strong class="note">Nota</strong>: 
  <p class="para">
   Se o arquivo foi aberto em modo de adição (<code class="literal">a</code> ou <code class="literal">a+</code>), quaisquer dados que
   sejam escritos no arquivo serão sempre acrescentados ao final, independente da
   posição do arquivo, e o resultado da chamada a
   <span class="function"><strong>fseek()</strong></span> será indefinido.
  </p>
 </p></blockquote>
 <blockquote class="note"><p><strong class="note">Nota</strong>: 
  <p class="para">
   Nem todos os fluxos suportam pesquisa. Para aqueles que não suportam,
   pesquisas além da posição atual podem ser feitas através
   da leitura e descarte de dados; outras formas de pesquisa irão falhar.
  </p>
 </p></blockquote>
</div>


<div class="refsect1 seealso" id="refsect1-function.fseek-seealso">
 <h3 class="title">Veja Também</h3>
 <p class="para">
  <ul class="simplelist">
   <li><span class="function"><a href="function.ftell.php" class="function" rel="rdfs-seeAlso">ftell()</a> - Retorna a posi&ccedil;&atilde;o atual do ponteiro de leitura/grava&ccedil;&atilde;o do arquivo</span></li>
   <li><span class="function"><a href="function.rewind.php" class="function" rel="rdfs-seeAlso">rewind()</a> - Retrocede a posi&ccedil;&atilde;o de um ponteiro de arquivos</span></li>
  </ul>
 </p>
</div>


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