<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Write a formatted string to a stream</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ucwords.html">ucwords</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.vprintf.html">vprintf</a></div>
<div class="up"><a href="ref.strings.html">String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.vfprintf" class="refentry">
<div class="refnamediv">
<h1 class="refname">vfprintf</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">vfprintf</span> — <span class="dc-title">Write a formatted string to a stream</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.vfprintf-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>vfprintf</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$handle</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$format</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter">$args</code></span>
)</div>
<p class="para rdfs-comment">
Write a string produced according to <em><code class="parameter">format</code></em> to the
stream resource specified by <em><code class="parameter">handle</code></em>.
</p>
<p class="para">
Operates as <span class="function"><a href="function.fprintf.html" class="function">fprintf()</a></span> but accepts an array of
arguments, rather than a variable number of arguments.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.vfprintf-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">handle</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">format</code></em></span>
<dd>
<p class="para">
See <span class="function"><a href="function.sprintf.html" class="function">sprintf()</a></span> for a description of
<em><code class="parameter">format</code></em>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">args</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.vfprintf-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the length of the outputted string.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.vfprintf-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4926">
<p><strong>Example #1 <span class="function"><strong>vfprintf()</strong></span>: zero-padded integers</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?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 /></span><span style="color: #0000BB">vfprintf</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">, array(</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">// will write the formatted ISO date to date.txt<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.vfprintf-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.printf.html" class="function" rel="rdfs-seeAlso">printf()</a> - Output a formatted string</span></li>
<li class="member"> <span class="function"><a href="function.sprintf.html" class="function" rel="rdfs-seeAlso">sprintf()</a> - Return a formatted string</span></li>
<li class="member"> <span class="function"><a href="function.sscanf.html" class="function" rel="rdfs-seeAlso">sscanf()</a> - Parses input from a string according to a format</span></li>
<li class="member"> <span class="function"><a href="function.fscanf.html" class="function" rel="rdfs-seeAlso">fscanf()</a> - Parses input from a file according to a format</span></li>
<li class="member"> <span class="function"><a href="function.vsprintf.html" class="function" rel="rdfs-seeAlso">vsprintf()</a> - Return a formatted string</span></li>
<li class="member"> <span class="function"><a href="function.number-format.html" class="function" rel="rdfs-seeAlso">number_format()</a> - Format a number with grouped thousands</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ucwords.html">ucwords</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.vprintf.html">vprintf</a></div>
<div class="up"><a href="ref.strings.html">String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
