evolution-data-server-doc 3.18.5-1ubuntu1 / usr / share / gtk-doc / html / camel / camel-camel-debug.html

This file is indexed.

/usr/share/gtk-doc/html/camel/camel-camel-debug.html is in evolution-data-server-doc 3.18.5-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!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-debug: Camel Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Fundamentals.html" title="Fundamentals">
<link rel="prev" href="camel-camel.html" title="camel">
<link rel="next" href="CamelObject.html" title="CamelObject">
<meta name="generator" content="GTK-Doc V1.24 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#camel-camel-debug.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="Fundamentals.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="camel-camel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="CamelObject.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="camel-camel-debug"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-camel-debug.top_of_page"></a>camel-debug</span></h2>
<p>camel-debug</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="camel-camel-debug.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-camel-debug.html#camel-debug-init" title="camel_debug_init ()">camel_debug_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="camel-camel-debug.html#camel-debug" title="camel_debug ()">camel_debug</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="camel-camel-debug.html#camel-debug-start" title="camel_debug_start ()">camel_debug_start</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-camel-debug.html#camel-debug-end" title="camel_debug_end ()">camel_debug_end</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="camel-camel-debug.html#CAMEL-CHECK-GERROR:CAPS" title="CAMEL_CHECK_GERROR()">CAMEL_CHECK_GERROR</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="camel-camel-debug.html#CAMEL-CHECK-LOCAL-GERROR:CAPS" title="CAMEL_CHECK_LOCAL_GERROR()">CAMEL_CHECK_LOCAL_GERROR</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="camel-camel-debug.html#camel-pointer-tracker-track" title="camel_pointer_tracker_track()">camel_pointer_tracker_track</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-camel-debug.html#camel-pointer-tracker-track-with-info" title="camel_pointer_tracker_track_with_info ()">camel_pointer_tracker_track_with_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-camel-debug.html#camel-pointer-tracker-untrack" title="camel_pointer_tracker_untrack ()">camel_pointer_tracker_untrack</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-camel-debug.html#camel-pointer-tracker-dump" title="camel_pointer_tracker_dump ()">camel_pointer_tracker_dump</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Strings.html#GString"><span class="returnvalue">GString</span></a> *
</td>
<td class="function_name">
<a class="link" href="camel-camel-debug.html#camel-debug-get-backtrace" title="camel_debug_get_backtrace ()">camel_debug_get_backtrace</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="camel-camel-debug.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="camel-camel-debug.html#CAMEL-DEBUG-IMAP:CAPS" title="CAMEL_DEBUG_IMAP">CAMEL_DEBUG_IMAP</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="camel-camel-debug.html#CAMEL-DEBUG-IMAP-FOLDER:CAPS" title="CAMEL_DEBUG_IMAP_FOLDER">CAMEL_DEBUG_IMAP_FOLDER</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="camel-camel-debug.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="camel-camel-debug.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="camel-debug-init"></a><h3>camel_debug_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_debug_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Init camel debug.</p>
<p>CAMEL_DEBUG is set to a comma separated list of modules to debug.
The modules can contain module-specific specifiers after a ':', or
just act as a wildcard for the module or even specifier.  e.g. 'imap'
for imap debug, or 'imap:folder' for imap folder debug.  Additionaly,
':folder' can be used for a wildcard for any folder operations.</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-debug"></a><h3>camel_debug ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
camel_debug (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mode</code></em>);</pre>
<p>Check to see if a debug mode is activated.  <em class="parameter"><code>mode</code></em>
 takes one of two forms,
a fully qualified 'module:target', or a wildcard 'module' name.  It
returns a boolean to indicate if the module or module and target is
currently activated for debug output.</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-debug-start"></a><h3>camel_debug_start ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
camel_debug_start (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mode</code></em>);</pre>
<p>Start debug output for a given mode, used to make sure debug output
is output atomically and not interspersed with unrelated stuff.</p>
<div class="refsect3">
<a name="id-1.2.2.3.6.4.5"></a><h4>Returns</h4>
<p> Returns true if mode is set, and in which case, you must
call debug_end when finished any screen output.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="camel-debug-end"></a><h3>camel_debug_end ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_debug_end (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Call this when you're done with your debug output.  If and only if
you called camel_debug_start, and if it returns TRUE.</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-CHECK-GERROR:CAPS"></a><h3>CAMEL_CHECK_GERROR()</h3>
<pre class="programlisting">#define             CAMEL_CHECK_GERROR(object, method, expr, error)</pre>
<p>This sanity checks return values and <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GErrors</span></a>.  If returning
failure, make sure the <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> is set.  If returning success,
make sure the <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> is NOT set.</p>
<p>Example:</p>
<p>    success = class-&gt;foo (object, some_data, error);
    CAMEL_CHECK_GERROR (object, foo, success, error);
    return success;</p>
<p class="since">Since: <a class="link" href="api-index-2.32.html" title="Index of new symbols in 2.32">2.32</a></p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-CHECK-LOCAL-GERROR:CAPS"></a><h3>CAMEL_CHECK_LOCAL_GERROR()</h3>
<pre class="programlisting">#define             CAMEL_CHECK_LOCAL_GERROR(object, method, expr, error)</pre>
<p>Same as CAMEL_CHECK_GERROR, but for direct <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> pointers.</p>
<p>Example:</p>
<p>    success = class-&gt;foo (object, some_data, &amp;local_error);
    CAMEL_CHECK_LOCAL_GERROR (object, foo, success, local_error);
    return success;</p>
<p class="since">Since: <a class="link" href="api-index-3.12.html" title="Index of new symbols in 3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-pointer-tracker-track"></a><h3>camel_pointer_tracker_track()</h3>
<pre class="programlisting">#define             camel_pointer_tracker_track(ptr)</pre>
<p>Adds pointer 'ptr' to pointer tracker. Usual use case is to add object
to the tracker in GObject::init and remove it from tracker within
GObject::finalize. Since the tracker's functions are called, the application
prints summary of the pointers on console on exit. If everything gone right
then it prints message about all tracked pointers were removed. Otherwise
it prints summary of left pointers in the tracker. Added pointer should
be removed with pair function <a class="link" href="camel-camel-debug.html#camel-pointer-tracker-untrack" title="camel_pointer_tracker_untrack ()"><code class="function">camel_pointer_tracker_untrack()</code></a>.</p>
<p>See <a class="link" href="camel-camel-debug.html#camel-pointer-tracker-dump" title="camel_pointer_tracker_dump ()"><code class="function">camel_pointer_tracker_dump()</code></a>, <a class="link" href="camel-camel-debug.html#camel-pointer-tracker-track-with-info" title="camel_pointer_tracker_track_with_info ()"><code class="function">camel_pointer_tracker_track_with_info()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.2.3.6.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>ptr</p></td>
<td class="parameter_description"><p>pointer to add to pointer tracker</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-pointer-tracker-track-with-info"></a><h3>camel_pointer_tracker_track_with_info ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_pointer_tracker_track_with_info (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> ptr</code></em>,
                                       <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *info</code></em>);</pre>
<p>Adds pointer to the pointer tracker, with associated information,
which is printed in summary of pointer tracker printed by
<a class="link" href="camel-camel-debug.html#camel-pointer-tracker-dump" title="camel_pointer_tracker_dump ()"><code class="function">camel_pointer_tracker_dump()</code></a>. For convenience can be used
<a class="link" href="camel-camel-debug.html#camel-pointer-tracker-track" title="camel_pointer_tracker_track()"><code class="function">camel_pointer_tracker_track()</code></a>, which adds place of the caller
as <em class="parameter"><code>info</code></em>
. Added pointer should be removed with pair function
<a class="link" href="camel-camel-debug.html#camel-pointer-tracker-untrack" title="camel_pointer_tracker_untrack ()"><code class="function">camel_pointer_tracker_untrack()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.2.3.6.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ptr</p></td>
<td class="parameter_description"><p>pointer to add to the pointer tracker</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>info to print in tracker summary</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-pointer-tracker-untrack"></a><h3>camel_pointer_tracker_untrack ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_pointer_tracker_untrack (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> ptr</code></em>);</pre>
<p>Removes pointer from the pointer tracker. It's an error to try
to remove pointer which was not added to the tracker by
<a class="link" href="camel-camel-debug.html#camel-pointer-tracker-track" title="camel_pointer_tracker_track()"><code class="function">camel_pointer_tracker_track()</code></a> or <a class="link" href="camel-camel-debug.html#camel-pointer-tracker-track-with-info" title="camel_pointer_tracker_track_with_info ()"><code class="function">camel_pointer_tracker_track_with_info()</code></a>,
or a pointer which was already removed.</p>
<div class="refsect3">
<a name="id-1.2.2.3.6.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>ptr</p></td>
<td class="parameter_description"><p>pointer to remove from the tracker</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-pointer-tracker-dump"></a><h3>camel_pointer_tracker_dump ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_pointer_tracker_dump (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Prints information about currently stored pointers
in the pointer tracker. This is called automatically
on application exit if <a class="link" href="camel-camel-debug.html#camel-pointer-tracker-track" title="camel_pointer_tracker_track()"><code class="function">camel_pointer_tracker_track()</code></a> or
<a class="link" href="camel-camel-debug.html#camel-pointer-tracker-track-with-info" title="camel_pointer_tracker_track_with_info ()"><code class="function">camel_pointer_tracker_track_with_info()</code></a> was called.</p>
<p>Note: If the library is configured with --enable-backtraces,
then also backtraces where the pointer was added is printed
in the summary.</p>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-debug-get-backtrace"></a><h3>camel_debug_get_backtrace ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Strings.html#GString"><span class="returnvalue">GString</span></a> *
camel_debug_get_backtrace (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Gets current backtrace leading to this function call.</p>
<div class="refsect3">
<a name="id-1.2.2.3.6.12.5"></a><h4>Returns</h4>
<p> Current backtrace, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, if cannot determine it.</p>
<p>Note: Getting backtraces only works if the library was
configured with --enable-backtraces.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.12.html" title="Index of new symbols in 3.12">3.12</a></p>
</div>
</div>
<div class="refsect1">
<a name="camel-camel-debug.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CAMEL-DEBUG-IMAP:CAPS"></a><h3>CAMEL_DEBUG_IMAP</h3>
<pre class="programlisting">#define CAMEL_DEBUG_IMAP "imap"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-DEBUG-IMAP-FOLDER:CAPS"></a><h3>CAMEL_DEBUG_IMAP_FOLDER</h3>
<pre class="programlisting">#define CAMEL_DEBUG_IMAP_FOLDER "imap:folder"
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.