4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>camel-exception</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
7
7
<link rel="start" href="index.html" title="Camel Reference Manual">
8
8
<link rel="up" href="Fundamentals.html" title="Fundamentals">
9
9
<link rel="prev" href="Fundamentals.html" title="Fundamentals">
10
10
<link rel="next" href="camel-CamelObject.html" title="CamelObject">
11
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="classes.html" title="Part I. Camel Classes">
14
14
<link rel="chapter" href="ClassTree.html" title="Class hierarchy">
31
31
<th width="100%" align="center">Camel Reference Manual</th>
32
32
<td><a accesskey="n" href="camel-CamelObject.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2503262" class="shortcut">Top</a>
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2531904" class="shortcut">Top</a>
36
<a href="#id2548996" class="shortcut">Description</a></nobr></td></tr>
36
<a href="#id2577507" class="shortcut">Description</a></nobr></td></tr>
38
38
<div class="refentry" lang="en">
39
39
<a name="camel-camel-exception"></a><div class="titlepage"></div>
40
40
<div class="refnamediv"><table width="100%"><tr>
43
<a name="id2503262"></a><span class="refentrytitle">camel-exception</span>
43
<a name="id2531904"></a><span class="refentrytitle">camel-exception</span>
45
45
<p>camel-exception</p>
55
enum <a href="camel-camel-exception.html#ExceptionId">ExceptionId</a>;
56
struct <a href="camel-camel-exception.html#CamelException">CamelException</a>;
57
#define <a href="camel-camel-exception.html#CAMEL-EXCEPTION-INITIALISER:CAPS">CAMEL_EXCEPTION_INITIALISER</a>
58
<a href="camel-camel-exception.html#CamelException">CamelException</a>* <a href="camel-camel-exception.html#camel-exception-new">camel_exception_new</a> (void);
59
void <a href="camel-camel-exception.html#camel-exception-free">camel_exception_free</a> (<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex);
60
void <a href="camel-camel-exception.html#camel-exception-init">camel_exception_init</a> (<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex);
61
void <a href="camel-camel-exception.html#camel-exception-clear">camel_exception_clear</a> (<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex);
62
void <a href="camel-camel-exception.html#camel-exception-set">camel_exception_set</a> (<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex,
63
<a href="camel-camel-exception.html#ExceptionId">ExceptionId</a> id,
55
enum <a class="link" href="camel-camel-exception.html#ExceptionId">ExceptionId</a>;
56
struct <a class="link" href="camel-camel-exception.html#CamelException">CamelException</a>;
57
#define <a class="link" href="camel-camel-exception.html#CAMEL-EXCEPTION-INITIALISER:CAPS">CAMEL_EXCEPTION_INITIALISER</a>
58
<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a>* <a class="link" href="camel-camel-exception.html#camel-exception-new">camel_exception_new</a> (void);
59
void <a class="link" href="camel-camel-exception.html#camel-exception-free">camel_exception_free</a> (<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex);
60
void <a class="link" href="camel-camel-exception.html#camel-exception-init">camel_exception_init</a> (<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex);
61
void <a class="link" href="camel-camel-exception.html#camel-exception-clear">camel_exception_clear</a> (<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex);
62
void <a class="link" href="camel-camel-exception.html#camel-exception-set">camel_exception_set</a> (<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex,
63
<a class="link" href="camel-camel-exception.html#ExceptionId">ExceptionId</a> id,
65
void <a href="camel-camel-exception.html#camel-exception-setv">camel_exception_setv</a> (<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex,
66
<a href="camel-camel-exception.html#ExceptionId">ExceptionId</a> id,
65
void <a class="link" href="camel-camel-exception.html#camel-exception-setv">camel_exception_setv</a> (<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex,
66
<a class="link" href="camel-camel-exception.html#ExceptionId">ExceptionId</a> id,
67
67
const char *format,
69
void <a href="camel-camel-exception.html#camel-exception-xfer">camel_exception_xfer</a> (<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex_dst,
70
<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex_src);
71
<a href="camel-camel-exception.html#ExceptionId">ExceptionId</a> <a href="camel-camel-exception.html#camel-exception-get-id">camel_exception_get_id</a> (<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex);
72
const char* <a href="camel-camel-exception.html#camel-exception-get-description">camel_exception_get_description</a> (<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex);
73
#define <a href="camel-camel-exception.html#camel-exception-is-set">camel_exception_is_set</a> (ex)
69
void <a class="link" href="camel-camel-exception.html#camel-exception-xfer">camel_exception_xfer</a> (<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex_dst,
70
<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex_src);
71
<a class="link" href="camel-camel-exception.html#ExceptionId">ExceptionId</a> <a class="link" href="camel-camel-exception.html#camel-exception-get-id">camel_exception_get_id</a> (<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex);
72
const char* <a class="link" href="camel-camel-exception.html#camel-exception-get-description">camel_exception_get_description</a> (<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex);
73
#define <a class="link" href="camel-camel-exception.html#camel-exception-is-set">camel_exception_is_set</a> (ex)
76
76
<div class="refsect1" lang="en">
77
<a name="id2548996"></a><h2>Description</h2>
77
<a name="id2577507"></a><h2>Description</h2>
82
82
<div class="refsect1" lang="en">
83
<a name="id2549011"></a><h2>Details</h2>
83
<a name="id2577521"></a><h2>Details</h2>
84
84
<div class="refsect2" lang="en">
85
<a name="id2549021"></a><h3>
85
<a name="id2577532"></a><h3>
86
86
<a name="ExceptionId"></a>enum ExceptionId</h3>
87
<a class="indexterm" name="id2549033"></a><pre class="programlisting">typedef enum {
87
<a class="indexterm" name="id2577544"></a><pre class="programlisting">typedef enum {
88
88
#include "camel-exception-list.def"
140
140
<div class="refsect2" lang="en">
141
<a name="id2549157"></a><h3>
141
<a name="id2577668"></a><h3>
142
142
<a name="camel-exception-free"></a>camel_exception_free ()</h3>
143
<a class="indexterm" name="id2549173"></a><pre class="programlisting">void camel_exception_free (<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex);</pre>
143
<a class="indexterm" name="id2577684"></a><pre class="programlisting">void camel_exception_free (<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex);</pre>
145
Free an exception object. If the exception is <a
146
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
147
><code class="literal">NULL</code></a>, nothing is
145
Free an exception object. If the exception is <code class="literal">NULL</code>, nothing is
148
146
done, the routine simply returns.</p>
152
150
<div class="variablelist"><table border="0">
153
151
<col align="left" valign="top">
155
<td><span class="term"><em class="parameter"><code>ex</code></em> :</span></td>
156
<td> a <a href="camel-camel-exception.html#CamelException"><span class="type">CamelException</span></a>
153
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
154
<td> a <a class="link" href="camel-camel-exception.html#CamelException"><span class="type">CamelException</span></a>
162
160
<div class="refsect2" lang="en">
163
<a name="id2549247"></a><h3>
161
<a name="id2577757"></a><h3>
164
162
<a name="camel-exception-init"></a>camel_exception_init ()</h3>
165
<a class="indexterm" name="id2549260"></a><pre class="programlisting">void camel_exception_init (<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex);</pre>
163
<a class="indexterm" name="id2577770"></a><pre class="programlisting">void camel_exception_init (<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex);</pre>
167
165
Init an exception. This routine is mainly useful when using a
168
166
statically allocated exception.</p>
172
170
<div class="variablelist"><table border="0">
173
171
<col align="left" valign="top">
175
<td><span class="term"><em class="parameter"><code>ex</code></em> :</span></td>
176
<td> a <a href="camel-camel-exception.html#CamelException"><span class="type">CamelException</span></a>
173
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
174
<td> a <a class="link" href="camel-camel-exception.html#CamelException"><span class="type">CamelException</span></a>
182
180
<div class="refsect2" lang="en">
183
<a name="id2549319"></a><h3>
181
<a name="id2577829"></a><h3>
184
182
<a name="camel-exception-clear"></a>camel_exception_clear ()</h3>
185
<a class="indexterm" name="id2549332"></a><pre class="programlisting">void camel_exception_clear (<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex);</pre>
183
<a class="indexterm" name="id2577842"></a><pre class="programlisting">void camel_exception_clear (<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex);</pre>
187
185
Clear an exception, that is, set the exception ID to
188
186
<span class="type">CAMEL_EXCEPTION_NONE</span> and free the description text. If the
190
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
191
><code class="literal">NULL</code></a>, this funtion just returns.</p>
187
exception is <code class="literal">NULL</code>, this funtion just returns.</p>
195
191
<div class="variablelist"><table border="0">
196
192
<col align="left" valign="top">
198
<td><span class="term"><em class="parameter"><code>ex</code></em> :</span></td>
199
<td> a <a href="camel-camel-exception.html#CamelException"><span class="type">CamelException</span></a>
194
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
195
<td> a <a class="link" href="camel-camel-exception.html#CamelException"><span class="type">CamelException</span></a>
205
201
<div class="refsect2" lang="en">
206
<a name="id2549412"></a><h3>
202
<a name="id2577922"></a><h3>
207
203
<a name="camel-exception-set"></a>camel_exception_set ()</h3>
208
<a class="indexterm" name="id2549425"></a><pre class="programlisting">void camel_exception_set (<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex,
209
<a href="camel-camel-exception.html#ExceptionId">ExceptionId</a> id,
204
<a class="indexterm" name="id2577935"></a><pre class="programlisting">void camel_exception_set (<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex,
205
<a class="link" href="camel-camel-exception.html#ExceptionId">ExceptionId</a> id,
210
206
const char *desc);</pre>
212
208
Set the value of an exception. The exception id is
226
220
<col align="left" valign="top">
229
<td><span class="term"><em class="parameter"><code>ex</code></em> :</span></td>
230
<td> a <a href="camel-camel-exception.html#CamelException"><span class="type">CamelException</span></a>
223
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
224
<td> a <a class="link" href="camel-camel-exception.html#CamelException"><span class="type">CamelException</span></a>
234
<td><span class="term"><em class="parameter"><code>id</code></em> :</span></td>
228
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
235
229
<td> exception id
239
<td><span class="term"><em class="parameter"><code>desc</code></em> :</span></td>
233
<td><p><span class="term"><em class="parameter"><code>desc</code></em> :</span></p></td>
240
234
<td> textual description of the exception
247
241
<div class="refsect2" lang="en">
248
<a name="id2549548"></a><h3>
242
<a name="id2578059"></a><h3>
249
243
<a name="camel-exception-setv"></a>camel_exception_setv ()</h3>
250
<a class="indexterm" name="id2549561"></a><pre class="programlisting">void camel_exception_setv (<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex,
251
<a href="camel-camel-exception.html#ExceptionId">ExceptionId</a> id,
244
<a class="indexterm" name="id2578072"></a><pre class="programlisting">void camel_exception_setv (<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex,
245
<a class="link" href="camel-camel-exception.html#ExceptionId">ExceptionId</a> id,
252
246
const char *format,
275
267
<col align="left" valign="top">
278
<td><span class="term"><em class="parameter"><code>ex</code></em> :</span></td>
279
<td> a <a href="camel-camel-exception.html#CamelException"><span class="type">CamelException</span></a>
270
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
271
<td> a <a class="link" href="camel-camel-exception.html#CamelException"><span class="type">CamelException</span></a>
283
<td><span class="term"><em class="parameter"><code>id</code></em> :</span></td>
275
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
284
276
<td> exception id
288
<td><span class="term"><em class="parameter"><code>format</code></em> :</span></td>
280
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
289
281
<td> format of the description string. The format string is
290
282
used as in <code class="function">printf()</code>.
294
<td><span class="term"><em class="parameter"><code>...</code></em> :</span></td>
286
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
304
296
<div class="refsect2" lang="en">
305
<a name="id2549718"></a><h3>
297
<a name="id2578229"></a><h3>
306
298
<a name="camel-exception-xfer"></a>camel_exception_xfer ()</h3>
307
<a class="indexterm" name="id2549731"></a><pre class="programlisting">void camel_exception_xfer (<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex_dst,
308
<a href="camel-camel-exception.html#CamelException">CamelException</a> *ex_src);</pre>
299
<a class="indexterm" name="id2578242"></a><pre class="programlisting">void camel_exception_xfer (<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex_dst,
300
<a class="link" href="camel-camel-exception.html#CamelException">CamelException</a> *ex_src);</pre>
310
302
Transfer the content of an exception from an exception object to
311
303
another. The destination exception receives the id and the
343
335
<col align="left" valign="top">
346
<td><span class="term"><em class="parameter"><code>ex</code></em> :</span></td>
347
<td> a <a href="camel-camel-exception.html#CamelException"><span class="type">CamelException</span></a>
338
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
339
<td> a <a class="link" href="camel-camel-exception.html#CamelException"><span class="type">CamelException</span></a>
351
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
343
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
352
344
<td>the exception id (<span class="type">CAMEL_EXCEPTION_NONE</span> will be returned if
353
<em class="parameter"><code>ex</code></em> is <a
354
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
355
><code class="literal">NULL</code></a> or unset)
345
<em class="parameter"><code>ex</code></em> is <code class="literal">NULL</code> or unset)
372
362
<col align="left" valign="top">
375
<td><span class="term"><em class="parameter"><code>ex</code></em> :</span></td>
376
<td> a <a href="camel-camel-exception.html#CamelException"><span class="type">CamelException</span></a>
365
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
366
<td> a <a class="link" href="camel-camel-exception.html#CamelException"><span class="type">CamelException</span></a>
380
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
381
<td>the exception description text (<a
382
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
383
><code class="literal">NULL</code></a> will be returned if
384
<em class="parameter"><code>ex</code></em> is <a
385
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
386
><code class="literal">NULL</code></a> or unset)
370
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
371
<td>the exception description text (<code class="literal">NULL</code> will be returned if
372
<em class="parameter"><code>ex</code></em> is <code class="literal">NULL</code> or unset)