File: odbc-fetch-into.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (150 lines) | stat: -rw-r--r-- 3,693 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
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.odbc-fetch-into" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>odbc_fetch_into</refname>
  <refpurpose>Fetch one result row into array</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>odbc_fetch_into</methodname>
   <methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
   <methodparam><type>array</type><parameter role="reference">result_array</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>rownumber</parameter></methodparam>
  </methodsynopsis>
  <para>
   Fetch one result row into <type>array</type>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>result_id</parameter></term>
     <listitem>
      <para>
       The result <type>resource</type>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>result_array</parameter></term>
     <listitem>
      <para>
       The result <type>array</type>
       that can be of any type since it will be converted to type
       array. The array will contain the column values starting at array
       index 0.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>rownumber</parameter></term>
     <listitem>
      <para>
       The row number.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the number of columns in the result;
   &false; on error.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>4.2.0</entry>
       <entry>
        The <parameter>result_array</parameter> and <parameter>rownumber</parameter>
        parameters have been swapped. This allows the rownumber to be a constant again. 
       </entry>
      </row>
      <row>
       <entry>4.0.6</entry>
       <entry>
        The <parameter>rownumber</parameter> can no longer be passed in as a
        constant, but rather as a variable. This again changed in 4.2.0.
       </entry>
      </row>
      <row>
       <entry>4.0.5</entry>
       <entry>
        The <parameter>result_array</parameter> parameter no longer needs to
        be passed in by reference.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>odbc_fetch_into</function> examples</title>
    <programlisting role="php">
<![CDATA[
<?php
$rc = odbc_fetch_into($res_id, $my_array);
?>
]]>
    </programlisting>
    <para>
     or
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$rc = odbc_fetch_into($res_id, $my_array, 2);
?>
]]>
    </programlisting>
   </example>
  </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
-->