php-doc-en/reference/uodbc/functions/odbc-fetch-into.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

150 lines
3.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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
-->