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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>camel-exception</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Fundamentals.html" title="Fundamentals">
<link rel="prev" href="camel-camel-debug.html" title="camel-debug">
<link rel="next" href="camel-CamelObject.html" title="CamelObject">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="camel-camel-debug.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Fundamentals.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">Camel Reference Manual</th>
<td><a accesskey="n" href="camel-CamelObject.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#camel-camel-exception.synopsis" class="shortcut">Top</a>
|
<a href="#camel-camel-exception.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="camel-exception">
<a name="camel-camel-exception"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-camel-exception.top_of_page"></a>camel-exception</span></h2>
<p>camel-exception</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="camel-camel-exception.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum <a class="link" href="camel-camel-exception.html#ExceptionId" title="enum ExceptionId">ExceptionId</a>;
struct <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a>;
#define <a class="link" href="camel-camel-exception.html#CAMEL-EXCEPTION-INITIALISER:CAPS" title="CAMEL_EXCEPTION_INITIALISER">CAMEL_EXCEPTION_INITIALISER</a>
<a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="returnvalue">CamelException</span></a> * <a class="link" href="camel-camel-exception.html#camel-exception-new" title="camel_exception_new ()">camel_exception_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-exception.html#camel-exception-free" title="camel_exception_free ()">camel_exception_free</a> (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-exception.html#camel-exception-init" title="camel_exception_init ()">camel_exception_init</a> (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-exception.html#camel-exception-clear" title="camel_exception_clear ()">camel_exception_clear</a> (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-exception.html#camel-exception-set" title="camel_exception_set ()">camel_exception_set</a> (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#ExceptionId" title="enum ExceptionId"><span class="type">ExceptionId</span></a> id</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *desc</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-exception.html#camel-exception-setv" title="camel_exception_setv ()">camel_exception_setv</a> (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#ExceptionId" title="enum ExceptionId"><span class="type">ExceptionId</span></a> id</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>,
<em class="parameter"><code>...</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-exception.html#camel-exception-xfer" title="camel_exception_xfer ()">camel_exception_xfer</a> (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex_dst</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex_src</code></em>);
<a class="link" href="camel-camel-exception.html#ExceptionId" title="enum ExceptionId"><span class="returnvalue">ExceptionId</span></a> <a class="link" href="camel-camel-exception.html#camel-exception-get-id" title="camel_exception_get_id ()">camel_exception_get_id</a> (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="camel-camel-exception.html#camel-exception-get-description" title="camel_exception_get_description ()">camel_exception_get_description</a> (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);
#define <a class="link" href="camel-camel-exception.html#camel-exception-is-set" title="camel_exception_is_set()">camel_exception_is_set</a> (ex)
</pre>
</div>
<div class="refsect1" title="Description">
<a name="camel-camel-exception.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="camel-camel-exception.details"></a><h2>Details</h2>
<div class="refsect2" title="enum ExceptionId">
<a name="ExceptionId"></a><h3>enum ExceptionId</h3>
<pre class="programlisting">typedef enum {
#include "camel-exception-list.def"
} ExceptionId;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="struct CamelException">
<a name="CamelException"></a><h3>struct CamelException</h3>
<pre class="programlisting">struct CamelException {
/* do not access the fields directly */
ExceptionId id;
gchar *desc;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="CAMEL_EXCEPTION_INITIALISER">
<a name="CAMEL-EXCEPTION-INITIALISER:CAPS"></a><h3>CAMEL_EXCEPTION_INITIALISER</h3>
<pre class="programlisting">#define CAMEL_EXCEPTION_INITIALISER { 0, NULL }
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="camel_exception_new ()">
<a name="camel-exception-new"></a><h3>camel_exception_new ()</h3>
<pre class="programlisting"><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="returnvalue">CamelException</span></a> * camel_exception_new (<em class="parameter"><code><span class="type">void</span></code></em>);</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" title="camel_exception_free ()">
<a name="camel-exception-free"></a><h3>camel_exception_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_exception_free (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
<p>
Free an exception object. If the exception is <code class="literal">NULL</code>, nothing is
done, the routine simply returns.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_exception_init ()">
<a name="camel-exception-init"></a><h3>camel_exception_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_exception_init (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
<p>
Init an exception. This routine is mainly useful when using a
statically allocated exception.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_exception_clear ()">
<a name="camel-exception-clear"></a><h3>camel_exception_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_exception_clear (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
<p>
Clear an exception, that is, set the exception ID to
<span class="type">CAMEL_EXCEPTION_NONE</span> and free the description text. If the
exception is <code class="literal">NULL</code>, this funtion just returns.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_exception_set ()">
<a name="camel-exception-set"></a><h3>camel_exception_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_exception_set (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#ExceptionId" title="enum ExceptionId"><span class="type">ExceptionId</span></a> id</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *desc</code></em>);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>desc</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_exception_setv ()">
<a name="camel-exception-setv"></a><h3>camel_exception_setv ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_exception_setv (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#ExceptionId" title="enum ExceptionId"><span class="type">ExceptionId</span></a> id</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_exception_xfer ()">
<a name="camel-exception-xfer"></a><h3>camel_exception_xfer ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_exception_xfer (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex_dst</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex_src</code></em>);</pre>
<p>
Transfer the content of an exception from an exception object to
another. The destination exception receives the id and the
description text of the source exception.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ex_dst</code></em> :</span></p></td>
<td>Destination exception object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ex_src</code></em> :</span></p></td>
<td>Source exception object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_exception_get_id ()">
<a name="camel-exception-get-id"></a><h3>camel_exception_get_id ()</h3>
<pre class="programlisting"><a class="link" href="camel-camel-exception.html#ExceptionId" title="enum ExceptionId"><span class="returnvalue">ExceptionId</span></a> camel_exception_get_id (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
<p>
Get the id of an exception.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the exception id (<span class="type">CAMEL_EXCEPTION_NONE</span> will be returned if
<em class="parameter"><code>ex</code></em> is <code class="literal">NULL</code> or unset)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_exception_get_description ()">
<a name="camel-exception-get-description"></a><h3>camel_exception_get_description ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * camel_exception_get_description (<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
<p>
Get the exception description text.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the exception description text (<code class="literal">NULL</code> will be returned if
<em class="parameter"><code>ex</code></em> is <code class="literal">NULL</code> or unset)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_exception_is_set()">
<a name="camel-exception-is-set"></a><h3>camel_exception_is_set()</h3>
<pre class="programlisting">#define camel_exception_is_set(ex) (camel_exception_get_id (ex) != CAMEL_EXCEPTION_NONE)
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
