<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.splfileobject.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'es',
  ),
  'this' => 
  array (
    0 => 'splfileobject.fscanf.php',
    1 => 'SplFileObject::fscanf',
    2 => 'Analiza la entrada de un fichero de acuerdo a un formato',
  ),
  'up' => 
  array (
    0 => 'class.splfileobject.php',
    1 => 'SplFileObject',
  ),
  'prev' => 
  array (
    0 => 'splfileobject.fread.php',
    1 => 'SplFileObject::fread',
  ),
  'next' => 
  array (
    0 => 'splfileobject.fseek.php',
    1 => 'SplFileObject::fseek',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'es',
    'path' => 'reference/spl/splfileobject/fscanf.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="splfileobject.fscanf" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SplFileObject::fscanf</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.1.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">SplFileObject::fscanf</span> &mdash; <span class="dc-title">Analiza la entrada de un fichero de acuerdo a un formato</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-splfileobject.fscanf-description">
  <h3 class="title">Descripción</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><strong>SplFileObject::fscanf</strong></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.null.php" class="type null">null</a></span></span></div>

  <p class="simpara">
   Lee una línea de el fichero e interpreta este de acuerdo a el <code class="parameter">format</code>.
  </p>
  <p class="simpara">
   Cualquier espacio en blanco en el <code class="parameter">format</code> string coincide con cualquier espacio en blanco en la línea de
   el fichero. Esto significa que incluso un (<code class="literal">\t</code>) en el formato string puede coincidir con un sólo caracter de
   espacio en la secuencia de entrada.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-splfileobject.fscanf-parameters">
  <h3 class="title">Parámetros</h3>
  <dl>
   

     <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>
     <span class="simpara">
      Los valores opcionales asignados.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-splfileobject.fscanf-returnvalues">
  <h3 class="title">Valores devueltos</h3>
  <p class="simpara">
   Si sólo se pasa un parámetro a este método, los valores analizados serán devueltos
   como un <span class="type"><a href="language.types.array.php" class="type array">array</a></span>. De lo contrario, si se pasan los parámetros opcionales,
   el método devolverá el número de valores asignados. Los parámetros opcionales deben
   ser pasados por referencia.
  </p>
  <p class="simpara">
   Si se esperan más subcadenas en el <code class="parameter">format</code> de las disponibles
   en la línea leída del fichero, se devuelve <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>.
  </p>
  <p class="simpara">
   Cuando se usan parámetros opcionales y se alcanza el final de la línea leída del
   fichero antes de que se haya analizado ningún valor, se devuelve <code class="literal">-1</code>.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-splfileobject.fscanf-examples">
  <h3 class="title">Ejemplos</h3>
  <div class="example" id="example-1">
   <p><strong>Ejemplo #1 Ejemplo de <span class="methodname"><strong>SplFileObject::fscanf()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$file </span><span style="color: #007700">= new </span><span style="color: #0000BB">SplFileObject</span><span style="color: #007700">(</span><span style="color: #DD0000">"usuarios.txt"</span><span style="color: #007700">);<br />while (</span><span style="color: #0000BB">$usuarioinfo </span><span style="color: #007700">= </span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">fscanf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%s %s %s"</span><span style="color: #007700">)) {<br />   list (</span><span style="color: #0000BB">$nombre</span><span style="color: #007700">, </span><span style="color: #0000BB">$profesion</span><span style="color: #007700">, </span><span style="color: #0000BB">$codigopais</span><span style="color: #007700">) = </span><span style="color: #0000BB">$usuarioinfo</span><span style="color: #007700">;<br />   </span><span style="color: #FF8000">// Operar con  $name $profession $countrycode<br /></span><span style="color: #007700">}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>Contenido de usuarios.txt</p></div>
   <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>
 </div>


 <div class="refsect1 seealso" id="refsect1-splfileobject.fscanf-seealso">
  <h3 class="title">Ver también</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.fscanf.php" class="function" rel="rdfs-seeAlso">fscanf()</a> - Analiza un archivo seg&uacute;n un formato</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>
 </div>


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