1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
<?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-conn-errormsg" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>db2_conn_errormsg</refname>
<refpurpose>
Returns the last connection error message and SQLCODE value
</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> returns an error message and SQLCODE
value representing the reason the last database connection attempt failed.
As <function>db2_connect</function> returns &false; in the event of a failed
connection attempt, do not pass any parameters to
<function>db2_conn_errormsg</function> to retrieve the associated error
message and SQLCODE value.
</para>
<para>
If, however, the connection was successful but becomes invalid over time,
you can pass the <parameter>connection</parameter> parameter to retrieve
the associated error message and SQLCODE value for a specific connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource associated with a connection that initially
succeeded, but which over time became invalid.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a string containing the error message and SQLCODE value resulting
from a failed connection attempt. If there is no error associated with the last
connection attempt, <function>db2_conn_errormsg</function> returns an empty
string.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Retrieving the error message returned by a failed connection attempt</title>
<para>
The following example demonstrates how to return an error message and
SQLCODE value after deliberately passing invalid parameters to
<function>db2_connect</function>.
</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
-->
|
