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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaError</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GNOME Data Access manual">
<link rel="up" href="libgda-api.html" title="Client API Reference">
<link rel="prev" href="libgda-GdaDataModel.html" title="GdaDataModel">
<link rel="next" href="libgda-GdaExport.html" title="GdaExport">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="introduction.html" title="Introduction">
<link rel="chapter" href="architecture.html" title="libgda architecture">
<link rel="chapter" href="installation.html" title="Installation">
<link rel="chapter" href="connecting.html" title="Beginning">
<link rel="chapter" href="processing-queries.html" title="Processing queries">
<link rel="chapter" href="ch06.html" title="Transactions and batch processes">
<link rel="chapter" href="managing-errors.html" title="Managing errors">
<link rel="chapter" href="main_example.html" title="Full example">
<link rel="chapter" href="migration.html" title="Some formulae for migration from old version">
<link rel="chapter" href="libgda-api.html" title="Client API Reference">
<link rel="chapter" href="libgda-providers.html" title="GDA Providers">
<link rel="chapter" href="libgda-xql.html" title="XML Queries">
<link rel="chapter" href="libgda-reports.html" title="GDA Report Engine">
<link rel="appendix" href="fdl.html" title="Appendix A. GNU Free Documentation License">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgda-GdaDataModel.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgda-api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME Data Access manual</th>
<td><a accesskey="n" href="libgda-GdaExport.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libgda-GdaError.synopsis" class="shortcut">Top</a>
|
<a href="#libgda-GdaError.description" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgda-GdaError"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-GdaError.top_of_page"></a>GdaError</span></h2>
<p>GdaError — Management of errors</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgda-GdaError.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="libgda-GdaError.html#GdaErrorPrivate" title="GdaErrorPrivate">GdaErrorPrivate</a>;
GdaError* <a class="link" href="libgda-GdaError.html#gda-error-new" title="gda_error_new ()">gda_error_new</a> (void);
void <a class="link" href="libgda-GdaError.html#gda-error-free" title="gda_error_free ()">gda_error_free</a> (GdaError *error);
GList* <a class="link" href="libgda-GdaError.html#gda-error-list-copy" title="gda_error_list_copy ()">gda_error_list_copy</a> (const GList *errors);
void <a class="link" href="libgda-GdaError.html#gda-error-list-free" title="gda_error_list_free ()">gda_error_list_free</a> (GList *errors);
const gchar* <a class="link" href="libgda-GdaError.html#gda-error-get-description" title="gda_error_get_description ()">gda_error_get_description</a> (GdaError *error);
void <a class="link" href="libgda-GdaError.html#gda-error-set-description" title="gda_error_set_description ()">gda_error_set_description</a> (GdaError *error,
const gchar *description);
glong <a class="link" href="libgda-GdaError.html#gda-error-get-number" title="gda_error_get_number ()">gda_error_get_number</a> (GdaError *error);
void <a class="link" href="libgda-GdaError.html#gda-error-set-number" title="gda_error_set_number ()">gda_error_set_number</a> (GdaError *error,
glong number);
const gchar* <a class="link" href="libgda-GdaError.html#gda-error-get-source" title="gda_error_get_source ()">gda_error_get_source</a> (GdaError *error);
void <a class="link" href="libgda-GdaError.html#gda-error-set-source" title="gda_error_set_source ()">gda_error_set_source</a> (GdaError *error,
const gchar *source);
const gchar* <a class="link" href="libgda-GdaError.html#gda-error-get-sqlstate" title="gda_error_get_sqlstate ()">gda_error_get_sqlstate</a> (GdaError *error);
void <a class="link" href="libgda-GdaError.html#gda-error-set-sqlstate" title="gda_error_set_sqlstate ()">gda_error_set_sqlstate</a> (GdaError *error,
const gchar *sqlstate);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="libgda-GdaError.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="libgda-GdaError.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GdaErrorPrivate"></a><h3>GdaErrorPrivate</h3>
<pre class="programlisting">typedef struct _GdaErrorPrivate GdaErrorPrivate;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-error-new"></a><h3>gda_error_new ()</h3>
<pre class="programlisting">GdaError* gda_error_new (void);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-error-free"></a><h3>gda_error_free ()</h3>
<pre class="programlisting">void gda_error_free (GdaError *error);</pre>
<p>
Frees the memory allocated by the error object.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> the error object.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-error-list-copy"></a><h3>gda_error_list_copy ()</h3>
<pre class="programlisting">GList* gda_error_list_copy (const GList *errors);</pre>
<p>
Creates a new list which contains the same errors as <em class="parameter"><code>errors</code></em> and
adds a reference for each error in the list.
</p>
<p>
You must free the list using <a class="link" href="libgda-GdaError.html#gda-error-list-free" title="gda_error_list_free ()"><span class="type">gda_error_list_free</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>errors</code></em> :</span></p></td>
<td> a GList holding error objects.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a list of errors.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-error-list-free"></a><h3>gda_error_list_free ()</h3>
<pre class="programlisting">void gda_error_list_free (GList *errors);</pre>
<p>
Frees all error objects in the list and the list itself.
After this function has been called, the <em class="parameter"><code>errors</code></em> parameter doesn't point
to valid storage any more.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>errors</code></em> :</span></p></td>
<td> a GList holding error objects.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-error-get-description"></a><h3>gda_error_get_description ()</h3>
<pre class="programlisting">const gchar* gda_error_get_description (GdaError *error);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> a <span class="type">GdaError</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <em class="parameter"><code>error</code></em>'s description.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-error-set-description"></a><h3>gda_error_set_description ()</h3>
<pre class="programlisting">void gda_error_set_description (GdaError *error,
const gchar *description);</pre>
<p>
Sets <em class="parameter"><code>error</code></em>'s <em class="parameter"><code>description</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> a <span class="type">GdaError</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
<td> a description.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-error-get-number"></a><h3>gda_error_get_number ()</h3>
<pre class="programlisting">glong gda_error_get_number (GdaError *error);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> a <span class="type">GdaError</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <em class="parameter"><code>error</code></em>'s number.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-error-set-number"></a><h3>gda_error_set_number ()</h3>
<pre class="programlisting">void gda_error_set_number (GdaError *error,
glong number);</pre>
<p>
Sets <em class="parameter"><code>error</code></em>'s <em class="parameter"><code>number</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> a <span class="type">GdaError</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>number</code></em> :</span></p></td>
<td> a number.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-error-get-source"></a><h3>gda_error_get_source ()</h3>
<pre class="programlisting">const gchar* gda_error_get_source (GdaError *error);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> a <span class="type">GdaError</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <em class="parameter"><code>error</code></em>'s source.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-error-set-source"></a><h3>gda_error_set_source ()</h3>
<pre class="programlisting">void gda_error_set_source (GdaError *error,
const gchar *source);</pre>
<p>
Sets <em class="parameter"><code>error</code></em>'s <em class="parameter"><code>source</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> a <span class="type">GdaError</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
<td> a source.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-error-get-sqlstate"></a><h3>gda_error_get_sqlstate ()</h3>
<pre class="programlisting">const gchar* gda_error_get_sqlstate (GdaError *error);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> a <span class="type">GdaError</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <em class="parameter"><code>error</code></em>'s SQL state.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-error-set-sqlstate"></a><h3>gda_error_set_sqlstate ()</h3>
<pre class="programlisting">void gda_error_set_sqlstate (GdaError *error,
const gchar *sqlstate);</pre>
<p>
Sets <em class="parameter"><code>error</code></em>'s SQL state.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> a <span class="type">GdaError</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sqlstate</code></em> :</span></p></td>
<td> SQL state.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|
