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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/sesam.xml, last change in rev 1.1 -->
<refentry id="function.sesam-diagnostic">
<refnamediv>
<refname>sesam_diagnostic</refname>
<refpurpose>
Return status information for last SESAM call
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>sesam_diagnostic</methodname>
<void/>
</methodsynopsis>
<para>
Returns an associative array of status and return codes for the
last SQL query/statement/command. Elements of the array are:
<table>
<title>
Status information returned by <function>sesam_diagnostic</function>
</title>
<tgroup cols="2">
<thead>
<row>
<entry>Element</entry>
<entry>Contents</entry>
</row>
</thead>
<tbody>
<row>
<entry>$array["sqlstate"]</entry>
<entry>
5 digit SQL return code (see the SESAM manual for the
description of the possible values of SQLSTATE)
</entry>
</row>
<row>
<entry>$array["rowcount"]</entry>
<entry>
number of affected rows in last update/insert/delete (set
after "immediate" statements only)
</entry>
</row>
<row>
<entry>$array["errmsg"]</entry>
<entry>
"human readable" error message string (set after errors
only)
</entry>
</row>
<row>
<entry>$array["errcol"]</entry>
<entry>
error column number of previous error (0-based; or -1 if
undefined. Set after errors only)
</entry>
</row>
<row>
<entry>$array["errlin"]</entry>
<entry>
error line number of previous error (0-based; or -1 if
undefined. Set after errors only)
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
In the following example, a syntax error (E SEW42AE ILLEGAL
CHARACTER) is displayed by including the offending SQL statement
and pointing to the error location:
<example>
<title>Displaying SESAM error messages with error position</title>
<programlisting role="php">
<![CDATA[
<?php
// Function which prints a formatted error message,
// displaying a pointer to the syntax error in the
// SQL statement
function PrintReturncode($exec_str)
{
$err = Sesam_Diagnostic();
$colspan=4; // 4 cols for: sqlstate, errlin, errcol, rowcount
if ($err["errlin"] == -1)
--$colspan;
if ($err["errcol"] == -1)
--$colspan;
if ($err["rowcount"] == 0)
--$colspan;
echo "<table border=\"1\">\n";
echo "<tr><th colspan=\"" . $colspan . "\"><span class=\"spanred\">ERROR:</span> ".
htmlspecialchars($err["errmsg"]) . "</th></tr>\n";
if ($err["errcol"] >= 0) {
echo "<tr><td colspan=\"" . $colspan . "\"><pre>\n";
$errstmt = $exec_str . "\n";
for ($lin=0; $errstmt != ""; ++$lin) {
if ($lin != $err["errlin"]) { // $lin is less or greater than errlin
if (!($i = strchr($errstmt, "\n")))
$i = "";
$line = substr ($errstmt, 0, strlen($errstmt)-strlen($i)+1);
$errstmt = substr($i, 1);
if ($line != "\n")
echo htmlspecialchars($line);
} else {
if (! ($i = strchr ($errstmt, "\n")))
$i = "";
$line = substr ($errstmt, 0, strlen ($errstmt)-strlen($i)+1);
$errstmt = substr($i, 1);
for ($col=0; $col < $err["errcol"]; ++$col) {
echo (substr($line, $col, 1) == "\t") ? "\t" : ".";
}
echo "<span class=\"spanred\">\\</span>\n";
echo "<span class=\"normal\">" . htmlspecialchars($line) . "</span>";
for ($col=0; $col < $err["errcol"]; ++$col) {
echo (substr ($line, $col, 1) == "\t") ? "\t" : ".";
}
echo "<span class=\"spanred\">/</span>\n";
}
}
echo "</pre></td></tr>\n";
}
echo "<tr>\n";
echo " <td>sqlstate=" . $err["sqlstate"] . "</td>\n";
if ($err["errlin"] != -1)
echo " <td>errlin=" . $err["errlin"] . "</td>\n";
if ($err["errcol"] != -1)
echo " <td>errcol=" . $err["errcol"] . "</td>\n";
if ($err["rowcount"] != 0)
echo " <td>rowcount=" . $err["rowcount"] . "</td>\n";
echo "</tr>\n";
echo "</table>\n";
}
if (!sesam_connect ("mycatalog", "phoneno", "otto"))
die ("cannot connect");
$stmt = "SELECT * FROM phone\n" .
" WHERE@ LASTNAME='KRAEMER'\n" .
" ORDER BY FIRSTNAME";
if (!($result = sesam_query ($stmt)))
PrintReturncode ($stmt);
?>
]]>
</programlisting>
</example>
</para>
<para>
See also: <function>sesam_errormsg</function> for simple access
to the error string only
</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:"../../../../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
-->
|
