db2-conn-errormsg.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 871b71764cdca8238069f27436d96011a6a2cb36 Maintainer: takagi Status: ready -->
<refentry xml:id="function.db2-conn-errormsg" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_conn_errormsg</refname>
  <refpurpose>
   直近の接続エラーメッセージおよび SQLCODE を返す
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>db2_conn_errormsg</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_errormsg</function> は、データベースへの直近の接続が
   失敗した原因を表す SQLCODE およびエラーメッセージを返します。
   接続が失敗した場合には、<function>db2_connect</function> は &false; を返します。
   この場合、エラーメッセージおよび SQLSTATE の値を取得するために
   <function>db2_conn_errormsg</function> に何もパラメータを渡す必要はありません。
  </para>
  <para>
   しかし、接続は成功したもののその後に無効になった場合は、
   パラメータ <parameter>connection</parameter> を指定することで
   特定の接続についてのエラーメッセージおよび SQLSTATE を取得することができます。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
      <listitem>
       <para>
        当初は成功したものの、その後に無効になった接続に
        関連付けられた接続リソース。
       </para>
      </listitem>
     </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   失敗した接続試行の結果を表すエラーメッセージおよび SQLSTATE を返します。
   直近の接続試行に関連するエラーがない場合には、
   <function>db2_conn_errormsg</function> はn空の文字列を返します。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>失敗した接続試行からのエラーメッセージの取得</title>
    <para>
     以下の例では、<function>db2_connect</function> に
     わざと無効なパラメータを渡し、エラーメッセージおよび
     SQLSTATE を取得しています。
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$conn = db2_connect('badname', 'baduser', 'badpassword');
if (!$conn) {
    print db2_conn_errormsg();
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
[IBM][CLI Driver] SQL1013N  The database alias name
or database name "BADNAME" could not be found.  SQLSTATE=42705
 SQLCODE=-1013
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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