<!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>Retrieves the number of fields (columns) on a statement</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.sqlsrv-next-result.html">sqlsrv_next_result</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.sqlsrv-num-rows.html">sqlsrv_num_rows</a></div>
<div class="up"><a href="ref.sqlsrv.html">SQLSRV Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.sqlsrv-num-fields" class="refentry">
<div class="refnamediv">
<h1 class="refname">sqlsrv_num_fields</h1>
<p class="verinfo">(No version information available, might only be in SVN)</p><p class="refpurpose"><span class="refname">sqlsrv_num_fields</span> — <span class="dc-title">Retrieves the number of fields (columns) on a statement</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.sqlsrv-num-fields-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>sqlsrv_num_fields</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$stmt</code></span>
)</div>
<p class="para rdfs-comment">
Retrieves the number of fields (columns) on a statement.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.sqlsrv-num-fields-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">stmt</code></em></span>
<dd>
<p class="para">
The statment for which the number of fields is returned.
<span class="function"><strong>sqlsrv_num_fields()</strong></span> can be called on a statement before
or after statement execution.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.sqlsrv-num-fields-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the number of fields on success. Returns <strong><code>FALSE</code></strong> otherwise.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.sqlsrv-num-fields-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2186">
<p><strong>Example #1 <span class="function"><strong>sqlsrv_num_fields()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$serverName </span><span style="color: #007700">= </span><span style="color: #DD0000">"serverName\sqlexpress"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$connectionInfo </span><span style="color: #007700">= array( </span><span style="color: #DD0000">"Database"</span><span style="color: #007700">=></span><span style="color: #DD0000">"dbName"</span><span style="color: #007700">, </span><span style="color: #DD0000">"UID"</span><span style="color: #007700">=></span><span style="color: #DD0000">"username"</span><span style="color: #007700">, </span><span style="color: #DD0000">"PWD"</span><span style="color: #007700">=></span><span style="color: #DD0000">"password"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">sqlsrv_connect</span><span style="color: #007700">( </span><span style="color: #0000BB">$serverName</span><span style="color: #007700">, </span><span style="color: #0000BB">$connectionInfo</span><span style="color: #007700">);<br />if( </span><span style="color: #0000BB">$conn </span><span style="color: #007700">=== </span><span style="color: #0000BB">false </span><span style="color: #007700">) {<br /> die( </span><span style="color: #0000BB">print_r</span><span style="color: #007700">( </span><span style="color: #0000BB">sqlsrv_errors</span><span style="color: #007700">(), </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br />}<br /><br /></span><span style="color: #0000BB">$sql </span><span style="color: #007700">= </span><span style="color: #DD0000">"SELECT * FROM Table_1"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #0000BB">sqlsrv_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">$sql</span><span style="color: #007700">);<br />if( </span><span style="color: #0000BB">$stmt </span><span style="color: #007700">=== </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br /> die( </span><span style="color: #0000BB">print_r</span><span style="color: #007700">( </span><span style="color: #0000BB">sqlsrv_errors</span><span style="color: #007700">(), </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br />}<br /><br /></span><span style="color: #0000BB">$numFields </span><span style="color: #007700">= </span><span style="color: #0000BB">sqlsrv_num_fields</span><span style="color: #007700">( </span><span style="color: #0000BB">$stmt </span><span style="color: #007700">);<br /><br />while( </span><span style="color: #0000BB">sqlsrv_fetch</span><span style="color: #007700">( </span><span style="color: #0000BB">$stmt </span><span style="color: #007700">)) {<br /> </span><span style="color: #FF8000">// Iterate through the fields of each row.<br /> </span><span style="color: #007700">for(</span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700">< </span><span style="color: #0000BB">$numFields</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) { <br /> {<br /> echo </span><span style="color: #0000BB">sqlsrv_get_field</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">, </span><span style="color: #0000BB">$i</span><span style="color: #007700">).</span><span style="color: #DD0000">" "</span><span style="color: #007700">;<br /> }<br /> echo </span><span style="color: #DD0000">"<br />"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.sqlsrv-num-fields-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.sqlsrv-field-metadata.html" class="function" rel="rdfs-seeAlso">sqlsrv_field_metadata()</a> - Retrieves metadata for the fields of a statement prepared by
sqlsrv_prepare or sqlsrv_query</span></li>
<li class="member"> <span class="function"><a href="function.sqlsrv-fetch.html" class="function" rel="rdfs-seeAlso">sqlsrv_fetch()</a> - Makes the next row in a result set available for reading</span></li>
<li class="member"> <span class="function"><a href="function.sqlsrv-get-field.html" class="function" rel="rdfs-seeAlso">sqlsrv_get_field()</a> - Gets field data from the currently selected row</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.sqlsrv-next-result.html">sqlsrv_next_result</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.sqlsrv-num-rows.html">sqlsrv_num_rows</a></div>
<div class="up"><a href="ref.sqlsrv.html">SQLSRV Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
