cvs: phpdoc /en/reference/ibm_db2/functions db2-cursor-type.xml db2-stmt-error.xml db2-stmt-errormsg.xml
| From: | Dan Scott | Date: | Thu, 21 Apr 2005 16:15:11 +0000 |
| Subject: | cvs: phpdoc /en/reference/ibm_db2/functions db2-cursor-type.xml db2-stmt-error.xml db2-stmt-errormsg.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969367950@lists.php.net to get a copy of this message | ||
dbs Thu Apr 21 12:15:11 2005 EDT
Modified files:
/phpdoc/en/reference/ibm_db2/functions db2-cursor-type.xml
db2-stmt-error.xml
db2-stmt-errormsg.xml
Log:
Basic documentation for three more APIs.
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-cursor-type.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/ibm_db2/functions/db2-cursor-type.xml diff -u phpdoc/en/reference/ibm_db2/functions/db2-cursor-type.xml:1.1 phpdoc/en/reference/ibm_db2/functions/db2-cursor-type.xml:1.2 --- phpdoc/en/reference/ibm_db2/functions/db2-cursor-type.xml:1.1 Tue Apr 12 17:12:48 2005 +++ phpdoc/en/reference/ibm_db2/functions/db2-cursor-type.xml Thu Apr 21 12:15:10 2005 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.db2-cursor-type"> <refnamediv> <refname>db2_cursor_type</refname> <refpurpose> - Returns the cursor type used by the indicated statement resource + Returns the cursor type used by a statement resource </refpurpose> </refnamediv> <refsect1 role="description"> @@ -15,7 +15,11 @@ <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.experimental.func; + <para> + Returns the cursor type used by a statement resource. Use this to determine + if you are working with a forward-only cursor or scrollable cursor. + </para> </refsect1> <refsect1 role="parameters"> @@ -24,58 +28,24 @@ <variablelist> <varlistentry> <term><parameter>stmt</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <listitem> + <para> + A valid statement resource. + </para> + </listitem> + </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity + Returns either <literal>DB2_FORWARD_ONLY</literal> if the statement + resource uses a forward-only cursor or <literal>DB2_SCROLLABLE</literal> if + the statement resource uses a scrollable cursor. </para> </refsect1> - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; @@ -107,19 +77,14 @@ </refsect1> --> - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>db2_prepare</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-stmt-error.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/ibm_db2/functions/db2-stmt-error.xml diff -u phpdoc/en/reference/ibm_db2/functions/db2-stmt-error.xml:1.1 phpdoc/en/reference/ibm_db2/functions/db2-stmt-error.xml:1.2 --- phpdoc/en/reference/ibm_db2/functions/db2-stmt-error.xml:1.1 Tue Apr 12 17:12:48 2005 +++ phpdoc/en/reference/ibm_db2/functions/db2-stmt-error.xml Thu Apr 21 12:15:10 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.db2-stmt-error"> <refnamediv> @@ -15,7 +15,24 @@ <methodparam choice="opt"><type>resource</type><parameter>stmt</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.experimental.func; + <para> + Returns a string containing the SQLSTATE value returned by an SQL statement. + </para> + <para> + If you do not pass a statement resource as an argument to + <function>db2_stmt_error</function>, the driver returns the SQLSTATE + value associated with the last attempt to return a statement resource, for + example, from <function>db2_prepare</function> or + <function>db2_exec</function>. + </para> + <para> + To learn what the SQLSTATE value means, you can issue the following command + at a DB2 Command Line Processor prompt: + <userinput>db2 '? <parameter>sqlstate-value</parameter>'</userinput>. You + can also call <function>db2_stmt_errormsg</function> to retrieve an + explicit error message and the associated SQLCODE value. + </para> </refsect1> <refsect1 role="parameters"> @@ -24,57 +41,21 @@ <variablelist> <varlistentry> <term><parameter>stmt</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <listitem> + <para> + A valid statement resource. + </para> + </listitem> + </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? + Returns a string containing an SQLSTATE value. </para> </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - <!-- Use when examples exist <refsect1 role="examples"> @@ -107,19 +88,16 @@ </refsect1> --> - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>db2_conn_error</function></member> + <member><function>db2_conn_errormsg</function></member> + <member><function>db2_stmt_errormsg</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-stmt-errormsg.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/ibm_db2/functions/db2-stmt-errormsg.xml diff -u phpdoc/en/reference/ibm_db2/functions/db2-stmt-errormsg.xml:1.1 phpdoc/en/reference/ibm_db2/functions/db2-stmt-errormsg.xml:1.2 --- phpdoc/en/reference/ibm_db2/functions/db2-stmt-errormsg.xml:1.1 Tue Apr 12 17:12:48 2005 +++ phpdoc/en/reference/ibm_db2/functions/db2-stmt-errormsg.xml Thu Apr 21 12:15:10 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.db2-stmt-errormsg"> <refnamediv> @@ -15,7 +15,10 @@ <methodparam choice="opt"><type>resource</type><parameter>stmt</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.experimental.func; + <para> + Returns a string containing the last SQL statement error message. + </para> </refsect1> <refsect1 role="parameters"> @@ -24,57 +27,29 @@ <variablelist> <varlistentry> <term><parameter>stmt</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <listitem> + <para> + A valid statement resource. + </para> + </listitem> + </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity + Returns a string containing the error message and SQLCODE value for the + last error that occurred issuing an SQL statement. </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> + If you do not pass a statement resource as an argument to + <function>db2_stmt_errormsg</function>, the driver returns the error + message associated with the last attempt to return a statement resource, + for example, from <function>db2_prepare</function> or + <function>db2_exec</function>. </para> </refsect1> - --> - <!-- Use when examples exist <refsect1 role="examples"> @@ -107,19 +82,16 @@ </refsect1> --> - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>db2_conn_error</function></member> + <member><function>db2_conn_errormsg</function></member> + <member><function>db2_stmt_error</function></member> </simplelist> </para> </refsect1> - --> - </refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-cursor-type.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/ibm_db2/functions/db2-cursor-type.xml diff -u phpdoc/en/reference/ibm_db2/functions/db2-cursor-type.xml:1.1 phpdoc/en/reference/ibm_db2/functions/db2-cursor-type.xml:1.2 --- phpdoc/en/reference/ibm_db2/functions/db2-cursor-type.xml:1.1 Tue Apr 12 17:12:48 2005 +++ phpdoc/en/reference/ibm_db2/functions/db2-cursor-type.xml Thu Apr 21 12:15:10 2005 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.db2-cursor-type"> <refnamediv> <refname>db2_cursor_type</refname> <refpurpose> - Returns the cursor type used by the indicated statement resource + Returns the cursor type used by a statement resource </refpurpose> </refnamediv> <refsect1 role="description"> @@ -15,7 +15,11 @@ <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.experimental.func; + <para> + Returns the cursor type used by a statement resource. Use this to determine + if you are working with a forward-only cursor or scrollable cursor. + </para> </refsect1> <refsect1 role="parameters"> @@ -24,58 +28,24 @@ <variablelist> <varlistentry> <term><parameter>stmt</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <listitem> + <para> + A valid statement resource. + </para> + </listitem> + </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity + Returns either <literal>DB2_FORWARD_ONLY</literal> if the statement + resource uses a forward-only cursor or <literal>DB2_SCROLLABLE</literal> if + the statement resource uses a scrollable cursor. </para> </refsect1> - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; @@ -107,19 +77,14 @@ </refsect1> --> - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>db2_prepare</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-stmt-error.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/ibm_db2/functions/db2-stmt-error.xml diff -u phpdoc/en/reference/ibm_db2/functions/db2-stmt-error.xml:1.1 phpdoc/en/reference/ibm_db2/functions/db2-stmt-error.xml:1.2 --- phpdoc/en/reference/ibm_db2/functions/db2-stmt-error.xml:1.1 Tue Apr 12 17:12:48 2005 +++ phpdoc/en/reference/ibm_db2/functions/db2-stmt-error.xml Thu Apr 21 12:15:10 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.db2-stmt-error"> <refnamediv> @@ -15,7 +15,24 @@ <methodparam choice="opt"><type>resource</type><parameter>stmt</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.experimental.func; + <para> + Returns a string containing the SQLSTATE value returned by an SQL statement. + </para> + <para> + If you do not pass a statement resource as an argument to + <function>db2_stmt_error</function>, the driver returns the SQLSTATE + value associated with the last attempt to return a statement resource, for + example, from <function>db2_prepare</function> or + <function>db2_exec</function>. + </para> + <para> + To learn what the SQLSTATE value means, you can issue the following command + at a DB2 Command Line Processor prompt: + <userinput>db2 '? <parameter>sqlstate-value</parameter>'</userinput>. You + can also call <function>db2_stmt_errormsg</function> to retrieve an + explicit error message and the associated SQLCODE value. + </para> </refsect1> <refsect1 role="parameters"> @@ -24,57 +41,21 @@ <variablelist> <varlistentry> <term><parameter>stmt</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <listitem> + <para> + A valid statement resource. + </para> + </listitem> + </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? + Returns a string containing an SQLSTATE value. </para> </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - <!-- Use when examples exist <refsect1 role="examples"> @@ -107,19 +88,16 @@ </refsect1> --> - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>db2_conn_error</function></member> + <member><function>db2_conn_errormsg</function></member> + <member><function>db2_stmt_errormsg</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-stmt-errormsg.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/ibm_db2/functions/db2-stmt-errormsg.xml diff -u phpdoc/en/reference/ibm_db2/functions/db2-stmt-errormsg.xml:1.1 phpdoc/en/reference/ibm_db2/functions/db2-stmt-errormsg.xml:1.2 --- phpdoc/en/reference/ibm_db2/functions/db2-stmt-errormsg.xml:1.1 Tue Apr 12 17:12:48 2005 +++ phpdoc/en/reference/ibm_db2/functions/db2-stmt-errormsg.xml Thu Apr 21 12:15:10 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.db2-stmt-errormsg"> <refnamediv> @@ -15,7 +15,10 @@ <methodparam choice="opt"><type>resource</type><parameter>stmt</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.experimental.func; + <para> + Returns a string containing the last SQL statement error message. + </para> </refsect1> <refsect1 role="parameters"> @@ -24,57 +27,29 @@ <variablelist> <varlistentry> <term><parameter>stmt</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> + <listitem> + <para> + A valid statement resource. + </para> + </listitem> + </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity + Returns a string containing the error message and SQLCODE value for the + last error that occurred issuing an SQL statement. </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> + If you do not pass a statement resource as an argument to + <function>db2_stmt_errormsg</function>, the driver returns the error + message associated with the last attempt to return a statement resource, + for example, from <function>db2_prepare</function> or + <function>db2_exec</function>. </para> </refsect1> - --> - <!-- Use when examples exist <refsect1 role="examples"> @@ -107,19 +82,16 @@ </refsect1> --> - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>db2_conn_error</function></member> + <member><function>db2_conn_errormsg</function></member> + <member><function>db2_stmt_error</function></member> </simplelist> </para> </refsect1> - --> - </refentry>