<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.strings.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.fprintf.php',
    1 => 'fprintf',
    2 => 'フォーマットされた文字列をストリームに書き込む',
  ),
  'up' => 
  array (
    0 => 'ref.strings.php',
    1 => 'String 関数',
  ),
  'prev' => 
  array (
    0 => 'function.explode.php',
    1 => 'explode',
  ),
  'next' => 
  array (
    0 => 'function.get-html-translation-table.php',
    1 => 'get_html_translation_table',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/strings/functions/fprintf.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.fprintf" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">fprintf</h1>
  <p class="verinfo">(PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">fprintf</span> &mdash; <span class="dc-title">フォーマットされた文字列をストリームに書き込む</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.fprintf-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>fprintf</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">...$values</code></span>): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>

  <p class="para rdfs-comment">
   <code class="parameter">format</code> によって作成された文字列を
   <code class="parameter">stream</code> で指定したストリームに書き込みます。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.fprintf-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>
を使用して作成したファイルシステムポインタリソース。</p>
     </dd>
    
    

 <dt><code class="parameter">format</code></dt>
 <dd>
  <p class="para">
   0個以上のディレクティブで構成されるフォーマット文字列:

   変換結果に直接コピーされる通常文字列 (<code class="literal">%</code> は除きます)
   と、<em>変換仕様</em>。
   これらのいずれも、自分が持つパラメータを取得します。
  </p>

  <p class="para">
   変換の仕様は、以下のプロトタイプに従います:
   <code class="literal">%[argnum$][flags][width][.precision]specifier</code>.
  </p>

  <p class="formalpara">
   <h5 class="title">Argnum</h5>
   <p class="para">
    何番目の引数を変換の対象にするかを指定するために、
    数値の後にドル記号 <code class="literal">$</code> を続けます。
   </p>
  </p>

  <p class="formalpara">
   <h5 class="title">Flags</h5>
   <p class="para">
    <table class="doctable informaltable">
     
      <thead>
       <tr>
        <th>フラグ</th>
        <th>説明</th>
       </tr>

      </thead>

      <tbody class="tbody">
       <tr>
        <td><code class="literal">-</code></td>
        <td>
         与えられたフィールドの幅を左寄せにします。
         右寄せがデフォルトです。
        </td>
       </tr>

       <tr>
        <td><code class="literal">+</code></td>
        <td>
         正の数値の前に付ける <code class="literal">+</code> 符号です;
         デフォルトは、負の数にだけマイナスの符号が数値の前に付きます。
        </td>
       </tr>

       <tr>
        <td><code class="literal"> </code>(space)</td>
        <td>
         スペースに変換される詰め物です。
         これがデフォルトです。
        </td>
       </tr>

       <tr>
        <td><code class="literal">0</code></td>
        <td>
         数値の左側を0埋めします。
         <code class="literal">s</code> 指定子を使うと、
         右側にも0埋めできます。
        </td>
       </tr>

       <tr>
        <td><code class="literal">&#039;</code>(char)</td>
        <td>
         指定された (char) で埋めます。
        </td>
       </tr>

      </tbody>
     
    </table>

   </p>
  </p>

  <p class="formalpara">
   <h5 class="title">Width</h5>
   <p class="para">
    (最小で)何文字がこの変換結果に含まれるかを数値で指定するか、
    <code class="literal">*</code> を指定します。
    <code class="literal">*</code> を指定した場合、
    指定子によってフォーマットされる値の前に、
    幅を追加の数値として指定します。
   </p>
  </p>

  <p class="formalpara">
   <h5 class="title">Precision</h5>
   <p class="para">
    ピリオド <code class="literal">.</code> の後に数値を続けるか、
    <code class="literal">*</code> を続けますが、
    その意味は指定子に依存します:
    <ul class="itemizedlist">
     <li class="listitem">
      <span class="simpara">
       <code class="literal">e</code>, <code class="literal">E</code>,
       <code class="literal">f</code> と <code class="literal">F</code>
       指定子の場合:
       小数点の後に表示する桁数 (デフォルトでは、この値は6です)
      </span>
     </li>
     <li class="listitem">
      <span class="simpara">
       <code class="literal">g</code>, <code class="literal">G</code>,
       <code class="literal">h</code>, <code class="literal">H</code> 指定子の場合:
       表示する最大の有効桁数
      </span>
     </li>
     <li class="listitem">
      <span class="simpara">
       <code class="literal">s</code> 指定子の場合:
       文字列を切り捨てる時点、つまり、文字列の最大の長さを設定します。
      </span>
     </li>
    </ul>
    <blockquote class="note"><p><strong class="note">注意</strong>: 
     <span class="simpara">
      明示的に精度を指定せず、ピリオドを指定した場合、精度は0として扱われます。
      <code class="literal">*</code> を使った場合、
      精度は指定子によってフォーマットされる値の前に、
      追加の数値として指定します。
     </span>
    </p></blockquote>
   </p>
  </p>

  <p class="para">
   <table class="doctable table">
    <caption><strong>指定子の一覧</strong></caption>
    
     <thead>
      <tr>
       <th>指定子</th>
       <th>説明</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><code class="literal">%</code></td>
       <td>
        文字通り、パーセント文字です。
        引数は不要です。
       </td>
      </tr>

      <tr>
       <td><code class="literal">b</code></td>
       <td>
        引数は整数として扱われ、2進数値として表現されます。
       </td>
      </tr>

      <tr>
       <td><code class="literal">c</code></td>
       <td>
        引数は整数として扱われ、ASCII文字として表現されます。
       </td>
      </tr>

      <tr>
       <td><code class="literal">d</code></td>
       <td>
        引数は整数として扱われ、(符号付き)10進数値として表現されます。
       </td>
      </tr>

      <tr>
       <td><code class="literal">e</code></td>
       <td>
        引数は科学的記法で表現された値(e.g. 1.2e+2)として扱われます。
       </td>
      </tr>

      <tr>
       <td><code class="literal">E</code></td>
       <td>
        <code class="literal">e</code> 指定子に似ていますが、
        大文字を使います(e.g. 1.2E+2)
       </td>
      </tr>

      <tr>
       <td><code class="literal">f</code></td>
       <td>
        引数は小数として扱われ、浮動小数点数値として表現されます(ロケールを考慮します)。
       </td>
      </tr>

      <tr>
       <td><code class="literal">F</code></td>
       <td>
        引数は小数として扱われ、浮動小数点数値として表現されます(ロケールを考慮しません)。
       </td>
      </tr>

      <tr>
       <td><code class="literal">g</code></td>
       <td>
        <p class="para">
         汎用フォーマット
        </p>
        <p class="para">
         P を精度を表す、ゼロでない値とします。
         精度が省略された場合、Pの値は6です。
         精度に0を指定した場合、Pの値は1になります。
         この場合、 <code class="literal">E</code> 指定子の変換結果は、
         X乗になります。
        </p>
        <p class="para">
         P &gt; X ≥ −4 の場合、<code class="literal">E</code>
         指定子の変換結果となり、精度は、P − (X + 1) になります。
         そうでない場合、<code class="literal">e</code> 指定子の変換結果となり、
         精度は、P - 1 になります。
        </p>
       </td>
      </tr>

      <tr>
       <td><code class="literal">G</code></td>
       <td>
        <code class="literal">g</code> 指定子に似ていますが、
        <code class="literal">E</code> と <code class="literal">f</code> を使います。
       </td>
      </tr>

      <tr>
       <td><code class="literal">h</code></td>
       <td>
        <code class="literal">g</code> 指定子に似ていますが、
        <code class="literal">F</code> を使います。
        PHP 8.0.0 以降で利用可能です。
       </td>
      </tr>

      <tr>
       <td><code class="literal">H</code></td>
       <td>
        <code class="literal">g</code> 指定子に似ていますが、
        <code class="literal">E</code> と <code class="literal">F</code> を使います。
        PHP 8.0.0 以降で利用可能です。
       </td>
      </tr>

      <tr>
       <td><code class="literal">o</code></td>
       <td>
        引数は整数として扱われ、8進数値として表現されます。
       </td>
      </tr>

      <tr>
       <td><code class="literal">s</code></td>
       <td>
        引数は文字列として扱われ、文字列として表現されます。
       </td>
      </tr>

      <tr>
       <td><code class="literal">u</code></td>
       <td>
        引数は整数として扱われ、符号なし10進数値として表現されます。
       </td>
      </tr>

      <tr>
       <td><code class="literal">x</code></td>
       <td>
        引数は整数として扱われ、16進数値(小文字)として表現されます。
       </td>
      </tr>

      <tr>
       <td><code class="literal">X</code></td>
       <td>
        引数は整数として扱われ、16進数値(大文字)として表現されます。
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>

  <div class="warning"><strong class="warning">警告</strong>
   <p class="para">
    <code class="literal">c</code> 指定子はパディングと幅を無視します
   </p>
  </div>

  <div class="warning"><strong class="warning">警告</strong>
   <p class="para">
    文字列と width
    指定子を、1文字の表現に1バイト以上必要な文字セットと一緒に使おうとすると、
    期待しない結果になるかもしれません。
   </p>
  </div>

  <p class="para">
   値は、指定子の型に合うように強制されます:
   <table class="doctable table">
    <caption><strong>型のハンドリング</strong></caption>
    
     <thead>
      <tr>
       <th>型</th>
       <th>指定子</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><span class="type"><a href="language.types.string.php" class="type string">string</a></span></td>
       <td><code class="literal">s</code></td>
      </tr>

      <tr>
       <td><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></td>
       <td>
        <code class="literal">d</code>,
        <code class="literal">u</code>,
        <code class="literal">c</code>,
        <code class="literal">o</code>,
        <code class="literal">x</code>,
        <code class="literal">X</code>,
        <code class="literal">b</code>
       </td>
      </tr>

      <tr>
       <td><span class="type"><a href="language.types.float.php" class="type float">float</a></span></td>
       <td>
        <code class="literal">e</code>,
        <code class="literal">E</code>,
        <code class="literal">f</code>,
        <code class="literal">F</code>,
        <code class="literal">g</code>,
        <code class="literal">G</code>,
        <code class="literal">h</code>,
        <code class="literal">H</code>
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </dd>


    
     <dt><code class="parameter">values</code></dt>
     <dd>
      <p class="para">
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.fprintf-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   書き込まれた文字列の長さを返します。
  </p>
 </div>

 <div class="refsect1 errors" id="refsect1-function.fprintf-errors">
  <h3 class="title">エラー / 例外</h3>
  
  <p class="para">
 　PHP 8.0.0 以降では、
   引数の数が0の場合に <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span>
   がスローされます。
   これより前のバージョンでは、代わりに <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>
   を発生させていました。
  </p>
  <p class="para">
   PHP 8.0.0 以降では、
   <code class="literal">[width]</code> の値が0より小さかったり、
   <strong><code><a href="reserved.constants.php#constant.php-int-max">PHP_INT_MAX</a></code></strong> より大きい場合に、
   <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> がスローされます。
   これより前のバージョンでは、代わりに <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>
   を発生させていました。
  </p>
  <p class="para">
   PHP 8.0.0 以降では、
   <code class="literal">[precision]</code> の値が0より小さかったり、
   <strong><code><a href="reserved.constants.php#constant.php-int-max">PHP_INT_MAX</a></code></strong> より大きい場合に、
   <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> がスローされます。
   これより前のバージョンでは、代わりに <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>
   を発生させていました。
  </p>
  <p class="para">
   PHP 8.0.0 以降では、
   引数が必要な数より少なかった場合、
   <span class="classname"><a href="class.argumentcounterror.php" class="classname">ArgumentCountError</a></span>
   がスローされます。
   これより前のバージョンでは、代わりに <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返し、<strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>
   を発生させていました。
  </p>

 </div>


 <div class="refsect1 changelog" id="refsect1-function.fprintf-changelog">
  <h3 class="title">変更履歴</h3>
  
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>バージョン</th>
      <th>説明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       この関数は、失敗時に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返さなくなりました。
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       引数の数が0だった場合、
       <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> がスローされるようになりました。
       これより前のバージョンでは、代わりに <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>
       を発生させていました。
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       <code class="literal">[width]</code> の値が0より小さかったり、
       <strong><code><a href="reserved.constants.php#constant.php-int-max">PHP_INT_MAX</a></code></strong> より大きい場合に、
       <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> をスローするようになりました。
       これより前のバージョンでは、代わりに <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>
       を発生させていました。
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       <code class="literal">[precision]</code> の値が0より小さかったり、
       <strong><code><a href="reserved.constants.php#constant.php-int-max">PHP_INT_MAX</a></code></strong> より大きい場合に、
       <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> をスローするようになりました。
       これより前のバージョンでは、代わりに <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>
       を発生させていました。
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       引数が必要な数より少なかった場合、
       <span class="classname"><a href="class.argumentcounterror.php" class="classname">ArgumentCountError</a></span>
       がスローされるようになりました。
       これより前のバージョンでは、代わりに <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>
       を発生させていました。
      </td>
     </tr>

    </tbody>
   
  </table>


 </div>


 <div class="refsect1 examples" id="refsect1-function.fprintf-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><strong>fprintf()</strong></span>: 数値のゼロ埋め</strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">if (!(</span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">'currency.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'w'</span><span style="color: #007700">))) {<br />    return;<br />}<br /><br /></span><span style="color: #0000BB">$year </span><span style="color: #007700">= </span><span style="color: #0000BB">2005</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$month </span><span style="color: #007700">= </span><span style="color: #0000BB">5</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$day </span><span style="color: #007700">= </span><span style="color: #0000BB">6</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">fprintf</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #DD0000">"%04d-%02d-%02d"</span><span style="color: #007700">, </span><span style="color: #0000BB">$year</span><span style="color: #007700">, </span><span style="color: #0000BB">$month</span><span style="color: #007700">, </span><span style="color: #0000BB">$day</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// ISO 形式にフォーマットした日付を date.txt に書き込みます<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
   <div class="example" id="example-2">
    <p><strong>例2 <span class="function"><strong>fprintf()</strong></span>: 金額のフォーマット</strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">if (!(</span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">'date.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'w'</span><span style="color: #007700">))) {<br />    return;<br />}<br /><br /></span><span style="color: #0000BB">$money1 </span><span style="color: #007700">= </span><span style="color: #0000BB">68.75</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$money2 </span><span style="color: #007700">= </span><span style="color: #0000BB">54.35</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$money </span><span style="color: #007700">= </span><span style="color: #0000BB">$money1 </span><span style="color: #007700">+ </span><span style="color: #0000BB">$money2</span><span style="color: #007700">;<br /></span><span style="color: #FF8000">// echo $money は "123.1" を出力します<br /></span><span style="color: #0000BB">$len </span><span style="color: #007700">= </span><span style="color: #0000BB">fprintf</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #DD0000">'%01.2f'</span><span style="color: #007700">, </span><span style="color: #0000BB">$money</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// "123.10" を currency.txt に書き込みます<br /><br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$len</span><span style="color: #DD0000"> バイトを currency.txt に書き込みました"</span><span style="color: #007700">;<br /></span><span style="color: #FF8000">// fprintf の戻り値を使用して、書き込まれたバイト数を取得します<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

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


 <div class="refsect1 seealso" id="refsect1-function.fprintf-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <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>
    <li><span class="function"><a href="function.vprintf.php" class="function" rel="rdfs-seeAlso">vprintf()</a> - フォーマットされた文字列を出力する</span></li>
    <li><span class="function"><a href="function.vsprintf.php" class="function" rel="rdfs-seeAlso">vsprintf()</a> - フォーマットされた文字列を返す</span></li>
    <li><span class="function"><a href="function.vfprintf.php" class="function" rel="rdfs-seeAlso">vfprintf()</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.fscanf.php" class="function" rel="rdfs-seeAlso">fscanf()</a> - フォーマットに基づきファイルからの入力を処理する</span></li>
    <li><span class="function"><a href="function.number-format.php" class="function" rel="rdfs-seeAlso">number_format()</a> - 数字を千の位毎にグループ化してフォーマットする</span></li>
    <li><span class="function"><a href="function.date.php" class="function" rel="rdfs-seeAlso">date()</a> - Unixタイムスタンプを書式化する</span></li>
   </ul>
  </p>
 </div>


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