<?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 => 'ja',
  ),
  'this' => 
  array (
    0 => 'splfileobject.fscanf.php',
    1 => 'SplFileObject::fscanf',
    2 => 'フォーマットに従ってファイルからの入力をパースする',
  ),
  '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' => 'ja',
    '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">フォーマットに従ってファイルからの入力をパースする</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-splfileobject.fscanf-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</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="para rdfs-comment">
   ファイルから 1 行読み込み、<code class="parameter">format</code> に従って解釈します。
  </p>
  <p class="para">
   <code class="parameter">format</code> 文字列のホワイトスペースはファイルからの行のホワイトスペースとマッチします。このことが意味するのはフォーマット文字列のタブ (<code class="literal">\t</code>) でさえも入力ストリームの 1 つのスペース文字とマッチしてしまうということです。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-splfileobject.fscanf-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    

     <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">argnum$</code> の代わりに
         <code class="literal">*</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-splfileobject.fscanf-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   このメソッドに渡される引数がひとつしかない場合、処理される値は配列として返されます。そうでなければ、オプションパラメータが渡される場合、メソッドは割り当て値の個数を返します。オプションパラメータは参照渡しでなければなりません。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-splfileobject.fscanf-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <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">"misc.txt"</span><span style="color: #007700">);<br />while (</span><span style="color: #0000BB">$userinfo </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">$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">// $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>users.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>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-splfileobject.fscanf-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.fscanf.php" class="function" rel="rdfs-seeAlso">fscanf()</a> - フォーマットに基づきファイルからの入力を処理する</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); ?>