db2-fetch-array.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-fetch-array" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_fetch_array</refname>
  <refpurpose>
   Returns an array, indexed by column position, representing a row in a result set
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>db2_fetch_array</methodname>
   <methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>row_number</parameter><initializer>-1</initializer></methodparam>
  </methodsynopsis>


  <para>
   Returns an array, indexed by column position, representing a row in a result
   set. The columns are 0-indexed.
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stmt</parameter></term>
     <listitem>
      <para>
       A valid <literal>stmt</literal> resource containing a result set.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>row_number</parameter></term>
     <listitem>
      <para>
       Requests a specific 1-indexed row from the result set. Passing this
       parameter results in a PHP warning if the result set uses a
       forward-only cursor.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a 0-indexed array with column values indexed by the column position
   representing the next or requested row in the result set. Returns &false; if
   there are no rows left in the result set, or if the row requested by
   <parameter>row_number</parameter> does not exist in the result set.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Iterating through a forward-only cursor</title>
    <para>
     If you call <function>db2_fetch_array</function> without a specific row
     number, it automatically retrieves the next row in the result set.
    </para>
    <programlisting role="php">
<![CDATA[
<?php

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

while ($row = db2_fetch_array($stmt)) {
    printf ("%-5d %-16s %-32s %10s\n", 
        $row[0], $row[1], $row[2], $row[3]);
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
0     Pook             cat                                    3.20
5     Rickety Ride     goat                                   9.70
2     Smarty           horse                                350.00
]]>
    </screen>
   </example>

   <example>
    <title>Retrieving specific rows with <function>db2_fetch_array</function>
     from a scrollable cursor</title>
    <para>
     If your result set uses a scrollable cursor, you can call
     <function>db2_fetch_array</function> with a specific row number. The
     following example retrieves every other row in the result set, starting
     with the second row.
    </para>
    <programlisting role="php">
<![CDATA[
<?php

$sql = "SELECT id, name, breed, weight FROM animals ORDER BY breed";
$result = db2_exec($stmt, $sql, array('cursor' => DB2_SCROLLABLE));

$i=2;
while ($row = db2_fetch_array($result, $i)) {
    printf ("%-5d %-16s %-32s %10s\n", 
        $row[0], $row[1], $row[2], $row[3]);
    $i = $i + 2;
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
0     Pook             cat                                    3.20
5     Rickety Ride     goat                                   9.70
2     Smarty           horse                                350.00
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>db2_fetch_assoc</function></member>
    <member><function>db2_fetch_both</function></member>
    <member><function>db2_fetch_object</function></member>
    <member><function>db2_fetch_row</function></member>
    <member><function>db2_result</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
-->