mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
- Implemented new doc style (parameter info and changelog)
- Updated documentation to reflect post 4.0.6 as current behaviour. - Removed old proto, and examples, and updated proto git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@260049 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
parent
2fb51efc71
commit
69d8354771
1 changed files with 89 additions and 75 deletions
|
@ -1,97 +1,111 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.10 $ -->
|
||||
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.34 -->
|
||||
<!-- $Revision: 1.11 $ -->
|
||||
<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>
|
||||
<title>Description</title>
|
||||
|
||||
<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><type>array</type><parameter>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>
|
||||
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.
|
||||
<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);
|
||||
</refsect1>
|
||||
|
||||
$rc = odbc_fetch_into($res_id, 1, $my_array);
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
<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> 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>
|
||||
<title><function>odbc_fetch_into</function> examples</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
|
Loading…
Reference in a new issue