db2-conn-error.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 871b71764cdca8238069f27436d96011a6a2cb36 Maintainer: jsgoupil Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.db2-conn-error" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_conn_error</refname>
  <refpurpose>
   Retourne une chaîne contenant la valeur de SQLSTATE retournée par la dernière tentative
   de connexion
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>db2_conn_error</methodname>
   <methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>

  <para>
   <function>db2_conn_error</function> retourne la valeur de SQLSTATE
   représentant la raison pour laquelle la dernière tentative de connexion à
   la base de données a échouée. Lorsque <function>db2_connect</function>
   retourne &false; en cas d'une tentative de connexion échouée, ne passez
   aucun paramètre à <function>db2_conn_error</function> pour obtenir la
   valeur de SQLSTATE.
  </para>
  <para>
   Si par contre la connexion était réussie mais est devenue invalide avec le
   temps, vous pouvez passer le paramètre de connexion
   <parameter>connection</parameter> pour obtenir la valeur de SQLSTATE pour la
   connexion spécifique.
  </para>
  <para>
   Pour comprendre les valeurs de SQLSTATE, vous pouvez taper la commande
   suivante dans le processeur de ligne de commandes de DB2 :
   <userinput>db2 '? <parameter>sqlstate-value</parameter>'</userinput>. Vous
   pouvez aussi appeler la fonction <function>db2_conn_errormsg</function>
   pour obtenir un message d'erreur explicite ainsi que la valeur de SQLCODE
   associée.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       Une ressource de connexion associée à la connexion qui a
       préalablement été réussie, mais qui est devenue invalide avec le temps.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne la valeur de SQLSTATE résultant d'une mauvaise tentative de
   connexion. Retourne une chaîne vide s'il n'y a pas d'erreur associée avec
   la dernière tentative de connexion. 
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Récupération de la valeur de SQLSTATE pour une tentative de connexion
    échouée</title>
    <para>
     L'exemple suivant montre comment retourner une valeur de SQLSTATE après un
     passage forcé d'un paramètre invalide à la fonction
     <function>db2_connect</function>.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$conn = db2_connect('mauvaisnom', 'mauvaisutilisateur', 'mauvaismotdepasse');
if (!$conn) {
    print "Valeur de SQLSTATE : " . db2_conn_error();
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Valeur de SQLSTATE : 08001
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>db2_conn_errormsg</function></member>
    <member><function>db2_connect</function></member>
    <member><function>db2_stmt_error</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
-->