File: dbx-fetch-row.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 (82 lines) | stat: -rw-r--r-- 2,614 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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
  <refentry id="function.dbx-fetch-row">
   <refnamediv>
    <refname>dbx_fetch_row</refname>
    <refpurpose>Fetches rows from a query-result that had the 
    <constant>DBX_RESULT_UNBUFFERED</constant> flag set</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>mixed</type><methodname>dbx_fetch_row</methodname>
      <methodparam><type>object</type><parameter>result_identifier</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     <function>dbx_fetch_row</function> returns a row on success, and 
     <literal>0</literal> on failure (e.g. when no more rows are available). 
     When the <constant>DBX_RESULT_UNBUFFERED</constant> is not set in the 
     query, <function>dbx_fetch_row</function> will fail as all rows have 
     already been fetched into the results <property>data</property> property.
    </simpara>
    <simpara>
     As a side effect, the <property>rows</property> property of the query-result
     object is incremented for each successful call to 
     <function>dbx_fetch_row</function>.
    </simpara>
    <example>
     <title>How to handle the returned value</title>
      <programlisting role="php">
<![CDATA[
<?php
$result = dbx_query($link, 'SELECT id, parentid, description FROM table', DBX_RESULT_UNBUFFERED);

echo "<table>\n";
while ($row = dbx_fetch_row($result)) {
    echo "<tr>\n";
    foreach ($row as $field) {
        echo "<td>$field</td>";
    }
    echo "</tr>\n";
}
echo "</table>\n";
?>
]]>
      </programlisting>
    </example>
    <para>
     The <parameter>result_identifier</parameter> parameter is the result
     object returned by a call to <function>dbx_query</function>.
    </para>
    <para>
     The returned object contains the same information as any row would have
     in the dbx_query result <property>data</property> property, including
     columns accessible by index or fieldname when the flags for dbx_guery
     were set that way.
    </para>
    <para>
     See also <function>dbx_query</function>.
    </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
-->