<?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 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.fscanf.php',
    1 => 'fscanf',
    2 => 'Обрабатывает данные из файла по условиям формата',
  ),
  'up' => 
  array (
    0 => 'ref.filesystem.php',
    1 => 'Функции файловой системы',
  ),
  'prev' => 
  array (
    0 => 'function.fread.php',
    1 => 'fread',
  ),
  'next' => 
  array (
    0 => 'function.fseek.php',
    1 => 'fseek',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    '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">Обрабатывает данные из файла по условиям формата</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.fscanf-description">
  <h3 class="title">Описание</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">
   Функция <span class="function"><strong>fscanf()</strong></span> аналогична функции
   <span class="function"><a href="function.sscanf.php" class="function">sscanf()</a></span>, но берёт входные данные из файла,
   который связан с потоком <code class="parameter">stream</code>, и интерпретирует входные данные
   по условиям формата <code class="parameter">format</code>.
  </p>
  <p class="para">
   Любой пробельный символ в строке формата эквивалентен любому
   пробельному символу во входящем потоке. Это означает, что даже символ табуляции
   (<code class="literal">\t</code>) в строке формата может соответствовать
   одному символу пробела в потоке входных данных.
  </p>
  <p class="para">
   Каждый вызов функции <span class="function"><strong>fscanf()</strong></span> считывает одну строку из файла.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.fscanf-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">stream</code></dt>
     <dd>
      <p class="para">Ресурс (<span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>)
указателя файловой системы, который обычно создают функцией <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">
    Формат интерпретации строки <code class="parameter">string</code>,
    который описывает документация к функции <span class="function"><a href="function.sprintf.php" class="function">sprintf()</a></span>
    со следующими отличиями:
    <ul class="simplelist">
     <li>
      Функция не учитывает языковые настройки.
     </li>
     <li>
      Параметр не поддерживает флаги <code class="literal">F</code>, <code class="literal">g</code>, <code class="literal">G</code>
      и <code class="literal">b</code>.
     </li>
     <li>
      Флаг <code class="literal">D</code> обозначает десятичное число.
     </li>
     <li>
      Флаг <code class="literal">i</code> обозначает целое число с определением системы счисления.
     </li>
     <li>
      Флаг <code class="literal">n</code> обозначает количество символов, которые функция уже обработала.
     </li>
     <li>
      Флаг <code class="literal">s</code> останавливает чтение при любом пробельном символе.
     </li>
     <li>
      Символ <code class="literal">*</code> вместо спецификатора преобразования <code class="literal">argnum$</code> подавляет
      присваивание этого спецификатора преобразования.
     </li>
    </ul>
   </p>
  </dd>
 

    
     <dt><code class="parameter">vars</code></dt>
     <dd>
      <p class="para">
       Необязательные переменные, которым функция присвоит значения.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.fscanf-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Функция возвращает массив с результатами разбора,
   если в функцию передали только два аргумента.
   Функция вернёт количество присвоенных значений, если передали необязательные аргументы.
   Необязательные аргументы требуется передавать по ссылке.
  </p>
  <p class="para">
   Если параметр <code class="parameter">format</code> ожидает больше подстрок,
   чем доступно в параметре <code class="parameter">string</code>, вернётся значение <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>.
   Функция вернёт <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, если возникнут другие ошибки.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.fscanf-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Пример использования функции <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 /><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 /><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">//... совершаем какие-либо действия над значениями<br /></span><span style="color: #007700">}<br /><br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$handle</span><span style="color: #007700">);<br /><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>Пример #2 Содержимое файла 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">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.fread.php" class="function" rel="rdfs-seeAlso">fread()</a> - Читает файл в бинарно-безопасном режиме: как последовательность байтов</span></li>
    <li><span class="function"><a href="function.fgets.php" class="function" rel="rdfs-seeAlso">fgets()</a> - Получает строку из указателя на файл</span></li>
    <li><span class="function"><a href="function.fgetss.php" class="function" rel="rdfs-seeAlso">fgetss()</a> - Читает строку из файла и удаляет HTML-теги</span></li>
    <li><span class="function"><a href="function.sscanf.php" class="function" rel="rdfs-seeAlso">sscanf()</a> - Разбирает строку по условиям формата</span></li>
    <li><span class="function"><a href="function.printf.php" class="function" rel="rdfs-seeAlso">printf()</a> - Выводит отформатированную строку</span></li>
    <li><span class="function"><a href="function.sprintf.php" class="function" rel="rdfs-seeAlso">sprintf()</a> - Возвращает отформатированную строку</span></li>
   </ul>
  </p>
 </div>


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