db2-num-fields.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.db2-num-fields" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_num_fields</refname>
  <refpurpose>
   Returns the number of fields contained in a result set
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>db2_num_fields</methodname>
   <methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
  </methodsynopsis>


  <para>
   Returns the number of fields contained in a result set. This is most useful
   for handling the result sets returned by dynamically generated queries, or
   for result sets returned by stored procedures, where your application cannot
   otherwise know how to retrieve and use the results.
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stmt</parameter></term>
     <listitem>
      <para>
       A valid statement resource containing a result set.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an integer value representing the number of fields in the result
   set associated with the specified statement resource. Returns &false; if
   the statement resource is not a valid input value. 
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Retrieving the number of fields in a result set</title>
    <para>
     The following example demonstrates how to retrieve the number of fields
     returned in a result set.
    </para>
    <programlisting role="php">
<![CDATA[
<?php

$sql = "SELECT id, name, breed, weight FROM animals ORDER BY breed";
$stmt = db2_prepare($conn, $sql);
db2_execute($stmt, $sql);
$columns = db2_num_fields($stmt);

echo "There are {$columns} columns in the result set.";
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
There are 4 columns in the result set.
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>db2_execute</function></member>
    <member><function>db2_field_display_size</function></member>
    <member><function>db2_field_name</function></member>
    <member><function>db2_field_num</function></member>
    <member><function>db2_field_precision</function></member>
    <member><function>db2_field_scale</function></member>
    <member><function>db2_field_type</function></member>
    <member><function>db2_field_width</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->