philip Fri Mar 25 20:35:15 2005 EDT
Modified files:
/phpdoc/en/reference/uodbc/functions odbc-fetch-array.xml
odbc-fetch-object.xml
Log:
Document this previously undocumented function. Use new doc style, and add
changelog for when this function is and is not available.
http://cvs.php.net/diff.php/phpdoc/en/reference/uodbc/functions/odbc-fetch-array.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/uodbc/functions/odbc-fetch-array.xml
diff -u phpdoc/en/reference/uodbc/functions/odbc-fetch-array.xml:1.2
phpdoc/en/reference/uodbc/functions/odbc-fetch-array.xml:1.3
--- phpdoc/en/reference/uodbc/functions/odbc-fetch-array.xml:1.2 Wed Apr
17 02:44:45 2002
+++ phpdoc/en/reference/uodbc/functions/odbc-fetch-array.xml Fri Mar 25
20:35:14 2005
@@ -1,25 +1,103 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
-<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.29 -->
- <refentry id='function.odbc-fetch-array'>
- <refnamediv>
- <refname>odbc_fetch_array</refname>
- <refpurpose>
- Fetch a result row as an associative array
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>array</type><methodname>odbc_fetch_array</methodname>
-
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>rownumber</parameter></methodparam>
- </methodsynopsis>
- <para>
- &warn.undocumented.func;
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.3 $ -->
+<refentry id="function.odbc-fetch-array">
+ <refnamediv>
+ <refname>odbc_fetch_array</refname>
+ <refpurpose>Fetch a result row as an associative array</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>array</type><methodname>odbc_fetch_array</methodname>
+
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>rownumber</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Fetch an associative <type>array</type> from an ODBC query. See the
+ changelog below for when this function is available.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result</parameter></term>
+ <listitem>
+ <para>
+ The result resource from <function>odbc_exec</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>rownumber</parameter></term>
+ <listitem>
+ <para>
+ Optionally choose which row number to retrieve.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns an array that corresponds to the fetched row, or &false; if there
+ are no more rows.
+ </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.3.3</entry>
+ <entry>
+ This function exists when compiled with IBM DB2 or UnixODBC support.
+ </entry>
+ </row>
+ <row>
+ <entry>4.3.2</entry>
+ <entry>
+ This function exists when compiled for Windows.
+ </entry>
+ </row>
+ <row>
+ <entry>4.0.2</entry>
+ <entry>
+ This function exists when compiled with DBMaker support.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>odbc_fetch_row</function></member>
+ <member><function>odbc_fetch_object</function></member>
+ <member><function>odbc_num_rows</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/uodbc/functions/odbc-fetch-object.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/uodbc/functions/odbc-fetch-object.xml
diff -u phpdoc/en/reference/uodbc/functions/odbc-fetch-object.xml:1.2
phpdoc/en/reference/uodbc/functions/odbc-fetch-object.xml:1.3
--- phpdoc/en/reference/uodbc/functions/odbc-fetch-object.xml:1.2 Wed Apr
17 02:44:45 2002
+++ phpdoc/en/reference/uodbc/functions/odbc-fetch-object.xml Fri Mar 25
20:35:14 2005
@@ -1,25 +1,103 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
-<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 -->
- <refentry id='function.odbc-fetch-object'>
- <refnamediv>
- <refname>odbc_fetch_object</refname>
- <refpurpose>
- Fetch a result row as an object
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>object</type><methodname>odbc_fetch_object</methodname>
-
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>rownumber</parameter></methodparam>
- </methodsynopsis>
- <para>
- &warn.undocumented.func;
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.3 $ -->
+<refentry id="function.odbc-fetch-object">
+ <refnamediv>
+ <refname>odbc_fetch_object</refname>
+ <refpurpose>Fetch a result row as an object</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>object</type><methodname>odbc_fetch_object</methodname>
+
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>rownumber</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Fetch an <type>object</type> from an ODBC query. See the changelog below
+ for when this function is available.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result</parameter></term>
+ <listitem>
+ <para>
+ The result resource from <function>odbc_exec</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>rownumber</parameter></term>
+ <listitem>
+ <para>
+ Optionally choose which row number to retrieve.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns an object that corresponds to the fetched row, or &false; if there
+ are no more rows.
+ </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.3.3</entry>
+ <entry>
+ This function exists when compiled with IBM DB2 or UnixODBC support.
+ </entry>
+ </row>
+ <row>
+ <entry>4.3.2</entry>
+ <entry>
+ This function exists when compiled for Windows.
+ </entry>
+ </row>
+ <row>
+ <entry>4.0.2</entry>
+ <entry>
+ This function exists when compiled with DBMaker support.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>odbc_fetch_row</function></member>
+ <member><function>odbc_fetch_array</function></member>
+ <member><function>odbc_num_rows</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
