[PATCH] odbc_next_result - Documenting the undocumented.

This is my first real patch for the documentation. It passed make test and make chm_xsl Building the extended CHM as we speak. Hopefully it is OK. It even has an example! WOO HOO! Regards, Richard Quadling. -- ----- Richard Quadling Zend Certified Engineer : http://zend.com/zce.php?c=ZEND002498&r=213474731 "Standing on the shoulders of some very clever giants!" -- ----- Richard Quadling Zend Certified Engineer : http://zend.com/zce.php?c=ZEND002498&r=213474731 "Standing on the shoulders of some very clever giants!"

Index: en/reference/uodbc/functions/odbc-next-result.xml =================================================================== RCS file: /repository/phpdoc/en/reference/uodbc/functions/odbc-next-result.xml,v retrieving revision 1.3 diff -u -r1.3 odbc-next-result.xml --- en/reference/uodbc/functions/odbc-next-result.xml 9 May 2003 13:12:17 -0000 1.3 +++ en/reference/uodbc/functions/odbc-next-result.xml 20 Nov 2006 13:59:34 -0000 @@ -15,7 +15,83 @@ <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> </methodsynopsis> <para> - &warn.undocumented.func; + <function>odbc_next_result</function> will return &true; if there are more result sets + available as well as allowing access to the next result set via + <function>odbc_fetch_array</function>, <function>odbc_fetch_row</function>, + <function>odbc_result</function>, etc. + </para> + <para> + This function will return &false; on error. + </para> + <para> + The argument is a valid result identifier returned by <function>odbc_exec</function>. + </para> + <para> + <example> + <title><function>odbc_next_result</function></title> + <programlisting role="php"> +<![CDATA[ +<?php +$r_Connection = odbc_connect($dsn, $username, $password); + +$s_SQL = <<<END_SQL +SELECT 'A' +SELECT 'B' +SELECT 'C' +END_SQL; + +$r_Results = odbc_exec($r_Connection, $s_SQL); + +$a_Row1 = odbc_fetch_array($r_Results); +$a_Row2 = odbc_fetch_array($r_Results); +echo "Dump first result set"; +var_dump($a_Row1, $a_Row2); + +echo "Get second results set "; +var_dump(odbc_next_result($r_Results)); + +$a_Row1 = odbc_fetch_array($r_Results); +$a_Row2 = odbc_fetch_array($r_Results); +echo "Dump second result set "; +var_dump($a_Row1, $a_Row2); + +echo "Get third results set "; +var_dump(odbc_next_result($r_Results)); + +$a_Row1 = odbc_fetch_array($r_Results); +$a_Row2 = odbc_fetch_array($r_Results); +echo "Dump third result set "; +var_dump($a_Row1, $a_Row2); + +echo "Try for a fourth result set "; +var_dump(odbc_next_result($r_Results)); +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Dump first result set array(1) { + ["A"]=> + string(1) "A" +} +bool(false) +Get second results set bool(true) +Dump second result set array(1) { + ["B"]=> + string(1) "B" +} +bool(false) +Get third results set bool(true) +Dump third result set array(1) { + ["C"]=> + string(1) "C" +} +bool(false) +Try for a fourth result set bool(false) +]]> + </screen> + </example> </para> </refsect1> </refentry>