File: odbc-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 (136 lines) | stat: -rw-r--r-- 3,807 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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.34 -->
  <refentry id="function.odbc-fetch-into">
   <refnamediv>
    <refname>odbc_fetch_into</refname>
    <refpurpose>Fetch one result row into array</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <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>
    <methodsynopsis>
     <type>bool</type><methodname>odbc_fetch_into</methodname>
     <methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
     <methodparam choice="opt"><type>int</type><parameter>rownumber</parameter></methodparam>
     <methodparam><type>array</type><parameter role="reference">result_array</parameter></methodparam>
    </methodsynopsis>
    <para>
     Returns the number of columns in the result;
     &false; on error.
     <parameter>result_array</parameter> must be passed by reference,
     but it 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>
    <para>
     As of PHP 4.0.5 the <parameter>result_array</parameter> does not
     need to be passed by reference any longer.
    </para>
    <para>
     As of PHP 4.0.6 the <parameter>rownumber</parameter> cannot be
     passed as a constant, but rather as a variable.
    </para>
    <para>
     As of PHP 4.2.0 the <parameter>result_array</parameter> and
     <parameter>rownumber</parameter> have been swapped. This allows the
     rownumber to be a constant again. This change will also be the last one
     to this function.
    </para>
    <para>
     <example>
      <title><function>odbc_fetch_into</function> pre 4.0.6 example </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, $row, $my_array);
       
$rc = odbc_fetch_into($res_id, 1, $my_array);
?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     <example>
      <title><function>odbc_fetch_into</function> 4.0.6 example</title>
      <programlisting role="php">
<![CDATA[
<?php
$rc = odbc_fetch_into($res_id, $my_array);
?>
]]>
      </programlisting>
      <para>
       or
      </para>
      <programlisting role="php">
<![CDATA[
<?php
$row = 1;
$rc = odbc_fetch_into($res_id, $row, $my_array);
?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     <example>
      <title><function>odbc_fetch_into</function> 4.2.0 example</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:"../../../../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
-->