php-doc-en/reference/ovrimos/functions/ovrimos-fetch-row.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.ovrimos-fetch-row" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ovrimos_fetch_row</refname>
  <refpurpose>Fetches a row from the result set</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ovrimos_fetch_row</methodname>
   <methodparam><type>int</type><parameter>result_id</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>how</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>row_number</parameter></methodparam>
  </methodsynopsis>
  <para>
   Fetches a row from the result set. Column values should be retrieved with
   other calls.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>result_id</parameter></term>
     <listitem>
      <para>
       A result identifier, returned by <function>ovrimos_execute</function>
       or <function>ovrimos_exec</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>how</parameter></term>
     <listitem>
      <para>
       Determines how the rows are fetched. This can be one of the following
       strings (case is not significant):
       <informaltable>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Option</entry>
           <entry>Notes</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>Next</literal></entry>
           <entry>
            Forward direction from current position.
            This is the default value.
           </entry>
          </row>
          <row>
           <entry><literal>Prev</literal></entry>
           <entry>
            Backward direction from current position.
           </entry>
          </row>
          <row>
           <entry><literal>First</literal></entry>
           <entry>
            Forward direction from the start.
           </entry>
          </row>
          <row>
           <entry><literal>Last</literal></entry>
           <entry>
            Backward direction from the end.
           </entry>
          </row>
          <row>
           <entry><literal>Absolute</literal></entry>
           <entry>
            Absolute position from the start.
            Requires <parameter>rownumber</parameter>. 
           </entry>
          </row>
         </tbody>
        </tgroup>
       </informaltable>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>rownumber</parameter></term>
     <listitem>
      <para>
       The row number, first one is 0. Only needed when 
       <parameter>how</parameter> is set to
       <literal>Absolute</literal>. 
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A fetch row example</title>
    <programlisting role="php">
<![CDATA[
<?php
$conn = ovrimos_connect("remote.host", "8001", "admin", "password");
if ($conn != 0) {
    echo "Connection ok!";
    $res=ovrimos_exec($conn, "select table_id, table_name from sys.tables");
    if ($res != 0) {
        echo "Statement ok!";
        if (ovrimos_fetch_row($res, "First")) {
            $table_id = ovrimos_result($res, 1);
            $table_name = ovrimos_result($res, 2);
            echo "table_id=" . $table_id . ", table_name=" . $table_name . "\n";
            if (ovrimos_fetch_row($res, "Next")) {
                $table_id = ovrimos_result($res, "table_id");
                $table_name = ovrimos_result($res, "table_name");
                echo "table_id=" . $table_id . ", table_name=" . $table_name . "\n";
            } else {
                echo "Next: error\n";
            }
        } else {
            echo "First: error\n";
        }
        ovrimos_free_result($res);
    }
    ovrimos_close($conn);
}
?>
]]>
    </programlisting>
   </example>
   This will fetch a row and print the result.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ovrimos_fetch_into</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:"../../../../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
-->