<?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 => 'zh',
  ),
  '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' => 'zh',
    '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="function"><a href="function.fopen.php" class="function">fopen()</a></span> 创建的 <span class="type"><a href="language.types.resource.php" class="type resource">resource</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> stands for integer with base detection.
        </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 />$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">//... do something with the values<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>示例 #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); ?>