db2-conn-error.xml

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

<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.db2-conn-error" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_conn_error</refname>
  <refpurpose>
   Devolver una cadena que contenga el valor SQLSTATE devuelto por el último intento de conexión.
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>db2_conn_error</methodname>
   <methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
  </methodsynopsis>


  <para>
   <function>db2_conn_error</function> devuelve un valor SQLSTATE que representa 
   el motivo por el que el último intento de conexión a la base de datos falló. Como
   <function>db2_connect</function> devuelve &false; cuando un intento de conexión 
   falla, no es necesario pasar algún argumento a 
   <function>db2_conn_error</function> para que devuelva el valor SQLSTATE.
  </para>
  <para>
   Si, de todos modos, la conexión fue exitosa pero en algún momento dejó de ser válida,
   se puede pasar el parámetro opcional <parameter>connection</parameter> para extraer el 
   valor SQLSTATE para una conexión específica.
  </para>
  <para>
   Para verificar el valor representado por SQLSTATE, se puede utilizar el siguiente comando  
   en alguna ventana de línea de comandos de DB2:
   <userinput>db2 '? <parameter>sqlstate-value</parameter>'</userinput>. Además 
   se puede llamasr a <function>db2_conn_errormsg</function> para obtener el mensaje de error 
   explícito asociado al valor SQLCODE.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       Es la conexión que se inició correctamente, pero que 
       en algún momento dejó de ser válida.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve el valor SQLSTATE que resultó de un intento de conexión fallido.
   Devuelve una cadena vacía si no hay ningún error asociado con el último intento de conexión.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Extrayendo el valor SQLSTATE de un intento de conexión fallido</title>
    <para>
     El siguiente ejemplo demuestra como obtener el valor SQLSTATE  
     después de pasar parámetros inválidos intencionalmente a 
     <function>db2_connect</function>.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$conn = db2_connect('badname', 'baduser', 'badpassword');
if (!$conn) {
    print "Valor SQLSTATE: " . db2_conn_error();
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
SQLSTATE value: 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
-->