File: ovrimos-fetch-row.xml

package info (click to toggle)
php-doc 20081024-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 57,752 kB
  • ctags: 3,858
  • sloc: xml: 686,554; php: 19,446; perl: 610; cpp: 500; makefile: 336; sh: 114; awk: 28
file content (180 lines) | stat: -rw-r--r-- 4,953 bytes parent folder | download
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
<?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
-->