File: errorhandling.html

package info (click to toggle)
libdbi 0.9.0-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 4,280 kB
  • sloc: sh: 10,708; ansic: 4,007; makefile: 116
file content (199 lines) | stat: -rw-r--r-- 4,259 bytes parent folder | download | duplicates (6)
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Error Handling</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="Database Independent Abstraction Layer for C"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Adding libdbi to your project"
HREF="addtoproject.html"><LINK
REL="NEXT"
TITLE="Connection error numbers and messages"
HREF="connerrors.html"></HEAD
><BODY
CLASS="CHAPTER"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Database Independent Abstraction Layer for C: libdbi Programmer's Guide</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="addtoproject.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="connerrors.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="CHAPTER"
><H1
><A
NAME="ERRORHANDLING"
></A
>Chapter 4. Error Handling</H1
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
>4.1. <A
HREF="connerrors.html"
>Connection error numbers and messages</A
></DT
><DT
>4.2. <A
HREF="errornumbers.html"
>Error numbers</A
></DT
></DL
></DIV
><P
>Applications should check all libdbi function calls for errors and respond appropriately to avoid entering an undefined status. libdbi uses two mechanisms to indicate errors:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>Function return values</DT
><DD
><P
>Essentially all libdbi functions return a value, a concept not unfamiliar to the seasoned C programmer. For example, the <A
HREF="reference-core.html#DBI-INITIALIZE"
>dbi_initialize</A
> function returns the number of loaded drivers, or -1 if an error occurred. In this case checking the return value is sufficient to detect an error condition. However, other functions like the family of "getters" cannot indicate error conditions with a return value. Consider e.g. the <A
HREF="reference-field.html#DBI-RESULT-GET-STRING"
>dbi_result_get_string</A
> function which is used to retrieve strings from a database. If there was an error in accessing the value, the function will return the string "ERROR". However, this string is a legal value of such a field (the problem is the same for any other conceivable return value, including the empty string and the NULL pointer). Therefore we need an additional mechanism to report errors.</P
></DD
><DT
>Error numbers and error messages</DT
><DD
><P
>Connections store the status of the most recent operation which can be queried by the accessor function <A
HREF="reference-conn.html#DBI-CONN-ERROR"
><CODE
CLASS="FUNCTION"
>dbi_conn_error</CODE
></A
>. This is equivalent to the <CODE
CLASS="VARNAME"
>errno</CODE
> variable of the standard C library which is used by most system calls and can be printed in human-readable form by the <CODE
CLASS="FUNCTION"
>perror</CODE
> system call. This mechanism implies that your program queries the status right after each operation, as the values will be overwritten by subsequent operations.</P
></DD
></DL
></DIV
><P
>The return values of all libdbi functions are listed in the <A
HREF="reference.html"
>reference</A
> chapter below. The error numbers will be briefly discussed in the following sections.</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="addtoproject.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="connerrors.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Adding libdbi to your project</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Connection error numbers and messages</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>