php-doc-en/reference/uodbc/functions/odbc-fetch-into.xml
Jakub Vrana 5fb3e0c98d Fix protos from sources
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@166703 c90b9560-bf6c-de11-be94-00142212c4b1
2004-08-18 15:39:26 +00:00

136 lines
3.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- 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>resource</type><methodname>odbc_fetch_into</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
<methodparam><type>array</type><parameter>&amp;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>&amp;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
-->