<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sqlsrv.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.sqlsrv-num-fields.php',
    1 => 'sqlsrv_num_fields',
    2 => 'Retrieves the number of fields (columns) on a statement',
  ),
  'up' => 
  array (
    0 => 'ref.sqlsrv.php',
    1 => 'SQLSRV Functions',
  ),
  'prev' => 
  array (
    0 => 'function.sqlsrv-next-result.php',
    1 => 'sqlsrv_next_result',
  ),
  'next' => 
  array (
    0 => 'function.sqlsrv-num-rows.php',
    1 => 'sqlsrv_num_rows',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/sqlsrv/functions/sqlsrv-num-fields.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<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 Git)</p><p class="refpurpose"><span class="refname">sqlsrv_num_fields</span> &mdash; <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="methodname"><strong>sqlsrv_num_fields</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$stmt</code></span>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>

  <p class="simpara">
   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>
  <dl>
   
    <dt><code class="parameter">stmt</code></dt>
    <dd>
     <span class="simpara">
      The statement 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.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.sqlsrv-num-fields-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   Returns the number of fields on success. Returns <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> otherwise.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.sqlsrv-num-fields-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <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">&lt;?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">=&gt;</span><span style="color: #DD0000">"dbName"</span><span style="color: #007700">, </span><span style="color: #DD0000">"UID"</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">"username"</span><span style="color: #007700">, </span><span style="color: #DD0000">"PWD"</span><span style="color: #007700">=&gt;</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">&lt; </span><span style="color: #0000BB">$numFields</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {<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">"&lt;br /&gt;"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.sqlsrv-num-fields-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.sqlsrv-field-metadata.php" 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><span class="function"><a href="function.sqlsrv-fetch.php" class="function" rel="rdfs-seeAlso">sqlsrv_fetch()</a> - Makes the next row in a result set available for reading</span></li>
   <li><span class="function"><a href="function.sqlsrv-get-field.php" class="function" rel="rdfs-seeAlso">sqlsrv_get_field()</a> - Gets field data from the currently selected row</span></li>
  </ul>
 </div>

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