<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.db2-stmt-error" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_stmt_error</refname>
  <refpurpose>
   Returns a string containing the SQLSTATE returned by an SQL statement
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>db2_stmt_error</methodname>
   <methodparam choice="opt"><type>resource</type><parameter>stmt</parameter></methodparam>
  </methodsynopsis>

  <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">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stmt</parameter></term>
     <listitem>
      <para>
       A valid statement resource.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a string containing an SQLSTATE value.
  </para>
 </refsect1>

 <!-- Use when examples exist
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>db2_stmt_error</function> example</title>
    <para>
     Any text that describes the purpose of the example, or
     what goes on in the example should go here (inside the
     <example> tag, not out
    </para>
    <programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
    echo 'Use the PEAR Coding Standards';
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 -->

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <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>

<!-- 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:"~/.phpdoc/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
-->