File: ovrimos-fetch-into.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (89 lines) | stat: -rw-r--r-- 3,225 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
  <refentry id="function.ovrimos-fetch-into">
   <refnamediv>
    <refname>ovrimos_fetch_into</refname>
    <refpurpose>Fetches a row from the result set</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>ovrimos_fetch_into</methodname>
      <methodparam><type>int</type><parameter>result_id</parameter></methodparam>
      <methodparam><type>array</type><parameter role="reference">result_array</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>how</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>rownumber</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ovrimos_fetch_into</function> fetches a row from the
     result set into <parameter>result_array</parameter>, which should
     be passed by reference. Which row is fetched is determined by the
     two last parameters. <parameter>how</parameter> is one of 
     <literal>Next</literal> (default), <literal>Prev</literal>, 
     <literal>First</literal>, <literal>Last</literal>, 
     <literal>Absolute</literal>, corresponding to forward direction from
     current position, backward direction from current position,
     forward direction from the start, backward direction from the end
     and absolute position from the start (essentially equivalent to
     'first' but needs 'rownumber'). Case is not
     significant. <parameter>rownumber</parameter> is optional except for
     absolute positioning. &return.success;
    </para>
    <para>
     <example>
      <title>A fetch into example</title>
      <programlisting role="php">
<![CDATA[
<?php
$conn=ovrimos_connect("neptune", "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_into($res, &$row)) {
            list($table_id, $table_name) = $row;
            echo "table_id=" . $table_id . ", table_name=" . $table_name . "\n";
            if (ovrimos_fetch_into($res, &$row)) {
                list($table_id, $table_name) = $row;
                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 example will fetch a row.
    </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
-->