<?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 => 'es',
  ),
  'this' => 
  array (
    0 => 'function.fscanf.php',
    1 => 'fscanf',
    2 => 'Analiza un archivo seg&uacute;n un formato',
  ),
  'up' => 
  array (
    0 => 'ref.filesystem.php',
    1 => 'Funciones del Sistema de Archivos',
  ),
  'prev' => 
  array (
    0 => 'function.fread.php',
    1 => 'fread',
  ),
  'next' => 
  array (
    0 => 'function.fseek.php',
    1 => 'fseek',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'es',
    'path' => 'reference/filesystem/functions/fscanf.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.fscanf" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">fscanf</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.1, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">fscanf</span> &mdash; <span class="dc-title">Analiza un archivo según un formato</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.fscanf-description">
  <h3 class="title">Descripción</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>fscanf</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.string.php" class="type string">string</a></span> <code class="parameter">$format</code></span>, <span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter reference">&...$vars</code></span>): <span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span>|<span class="type"><a href="language.types.null.php" class="type null">null</a></span></span></div>

  <p class="para rdfs-comment">
   La función <span class="function"><strong>fscanf()</strong></span> es similar a la función
   <span class="function"><a href="function.sscanf.php" class="function">sscanf()</a></span>, excepto que toma un archivo como entrada,
   representado por el recurso <code class="parameter">stream</code> e interpreta
   la entrada según el formato <code class="parameter">format</code> especificado.
  </p>
  <p class="para">
   Todos los caracteres en blanco de la cadena de formato corresponden
   a tantos espacios en el flujo de entrada. Esto significa que una tabulación
   (<code class="literal">\t</code>) en la cadena de formato puede reemplazar
   un espacio simple en el flujo de entrada.
  </p>
  <p class="para">
   Cada llamada a la función <span class="function"><strong>fscanf()</strong></span> lee una línea del archivo.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.fscanf-parameters">
  <h3 class="title">Parámetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">stream</code></dt>
     <dd>
      <p class="para">Un puntero del sistema de archivos de tipo <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>
que es habitualmente creado utilizando la función <span class="function"><a href="function.fopen.php" class="function">fopen()</a></span>.</p>
     </dd>
    
    

     <dt><code class="parameter">format</code></dt>
     <dd>
      <p class="para">
       El formato interpretado para <code class="parameter">string</code> se describe
       en la documentación de la <span class="function"><a href="function.sprintf.php" class="function">sprintf()</a></span> con las siguientes diferencias:
       <ul class="simplelist">
        <li>
         La función no tiene en cuenta el contexto local.
        </li>
        <li>
         <code class="literal">F</code>, <code class="literal">g</code>, <code class="literal">G</code> y
         <code class="literal">b</code> no son soportados.
        </li>
        <li>
         <code class="literal">D</code> representa un número decimal.
        </li>
        <li>
         <code class="literal">i</code> representa un número entero con detección de base.
        </li>
        <li>
         <code class="literal">n</code> representa el número de caracteres tratados hasta este punto.
        </li>
        <li>
         <code class="literal">s</code> detiene la lectura en cada carácter de espacio.
        </li>
        <li>
         <code class="literal">*</code> en lugar de <code class="literal">argnum$</code> elimina
         la asignación de esta especificación de conversión.
        </li>
       </ul>
      </p>
     </dd>
    

    
     <dt><code class="parameter">vars</code></dt>
     <dd>
      <p class="para">
       Los valores opcionales a asignar.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.fscanf-returnvalues">
  <h3 class="title">Valores devueltos</h3>
  <p class="para">
   Si solo se pasan 2 argumentos a la función, el valor analizado
   será devuelto en forma de un array. Si se pasan argumentos opcionales,
   la función devolverá el número de valores asignados.
   Los argumentos opcionales deben ser pasados por referencia.
  </p>
  <p class="para">
   Si se esperan más subcadenas en el <code class="parameter">format</code>
   de las disponibles en <code class="parameter">string</code>,
   <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> será devuelto. En otros casos de error, <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> será devuelto.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.fscanf-examples">
  <h3 class="title">Ejemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Ejemplo #1 Ejemplo con <span class="function"><strong>fscanf()</strong></span></strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$handle </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">"users.txt"</span><span style="color: #007700">, </span><span style="color: #DD0000">"r"</span><span style="color: #007700">);<br />while (</span><span style="color: #0000BB">$userinfo </span><span style="color: #007700">= </span><span style="color: #0000BB">fscanf</span><span style="color: #007700">(</span><span style="color: #0000BB">$handle</span><span style="color: #007700">, </span><span style="color: #DD0000">"%s\t%s\t%s\n"</span><span style="color: #007700">)) {<br />    list (</span><span style="color: #0000BB">$name</span><span style="color: #007700">, </span><span style="color: #0000BB">$profession</span><span style="color: #007700">, </span><span style="color: #0000BB">$countrycode</span><span style="color: #007700">) = </span><span style="color: #0000BB">$userinfo</span><span style="color: #007700">;<br />    </span><span style="color: #FF8000">//... procesamiento de datos<br /></span><span style="color: #007700">}<br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$handle</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
  <p class="para">
   <div class="example" id="example-2">
    <p><strong>Ejemplo #2 Contenido del archivo users.txt</strong></p>
    <div class="example-contents">
<div class="txtcode"><pre class="txtcode">javier  argonaut        pe
hiroshi sculptor        jp
robert  slacker us
luigi   florist it</pre>
</div>
    </div>

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


 <div class="refsect1 seealso" id="refsect1-function.fscanf-seealso">
  <h3 class="title">Ver también</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.fread.php" class="function" rel="rdfs-seeAlso">fread()</a> - Lectura del archivo en modo binario</span></li>
    <li><span class="function"><a href="function.fgets.php" class="function" rel="rdfs-seeAlso">fgets()</a> - Recupera la l&iacute;nea actual a partir de la posici&oacute;n del puntero de archivo</span></li>
    <li><span class="function"><a href="function.fgetss.php" class="function" rel="rdfs-seeAlso">fgetss()</a> - Obtiene un l&iacute;nea desde un puntero a un archivo y elimina las etiquetas HTML</span></li>
    <li><span class="function"><a href="function.sscanf.php" class="function" rel="rdfs-seeAlso">sscanf()</a> - Analiza una cadena utilizando un formato</span></li>
    <li><span class="function"><a href="function.printf.php" class="function" rel="rdfs-seeAlso">printf()</a> - Muestra una string formateada</span></li>
    <li><span class="function"><a href="function.sprintf.php" class="function" rel="rdfs-seeAlso">sprintf()</a> - Devuelve una string formateada</span></li>
   </ul>
  </p>
 </div>


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