evolution-data-server-doc 3.28.1-1ubuntu1 / usr / share / gtk-doc / html / camel / camel-camel-utils.html

This file is indexed.

/usr/share/gtk-doc/html/camel/camel-camel-utils.html is in evolution-data-server-doc 3.28.1-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
<!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-utils: 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="Utilities.html" title="Utilities">
<link rel="prev" href="camel-camel-utf8.html" title="camel-utf8">
<link rel="next" href="services.html" title="Part II. Built-in Services">
<meta name="generator" content="GTK-Doc V1.27 (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-utils.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="Utilities.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="camel-camel-utf8.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="services.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="camel-camel-utils"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-camel-utils.top_of_page"></a>camel-utils</span></h2>
<p>camel-utils</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="camel-camel-utils.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">
<a href="../glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>
</td>
<td class="function_name">
<a class="link" href="camel-camel-utils.html#camel-util-bdata-get-number" title="camel_util_bdata_get_number ()">camel_util_bdata_get_number</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-utils.html#camel-util-bdata-put-number" title="camel_util_bdata_put_number ()">camel_util_bdata_put_number</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="camel-camel-utils.html#camel-util-bdata-get-string" title="camel_util_bdata_get_string ()">camel_util_bdata_get_string</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-utils.html#camel-util-bdata-put-string" title="camel_util_bdata_put_string ()">camel_util_bdata_put_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">time_t</span>
</td>
<td class="function_name">
<a class="link" href="camel-camel-utils.html#camel-time-value-apply" title="camel_time_value_apply ()">camel_time_value_apply</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="camel-camel-utils.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="camel-camel-utils.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="camel-util-bdata-get-number"></a><h3>camel_util_bdata_get_number ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>
camel_util_bdata_get_number (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **bdata_ptr</code></em>,
                             <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> default_value</code></em>);</pre>
<p>Reads a numeric data from the <em class="parameter"><code>bdata_ptr</code></em>
 and moves the <em class="parameter"><code>bdata_ptr</code></em>

after that number. If the number cannot be read, then the <em class="parameter"><code>default_value</code></em>

is returned instead and the <em class="parameter"><code>bdata_ptr</code></em>
 is left unchanged. The number
might be previously stored with the <a class="link" href="camel-camel-utils.html#camel-util-bdata-put-number" title="camel_util_bdata_put_number ()"><code class="function">camel_util_bdata_put_number()</code></a>.</p>
<div class="refsect3">
<a name="camel-util-bdata-get-number.parameters"></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>bdata_ptr</p></td>
<td class="parameter_description"><p>a backend specific data (bdata) pointer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>default_value</p></td>
<td class="parameter_description"><p>a value to return, when no data can be read</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-util-bdata-get-number.returns"></a><h4>Returns</h4>
<p> The read number, or the <em class="parameter"><code>default_value</code></em>
, if the <em class="parameter"><code>bdata_ptr</code></em>
doesn't
point to a number.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-util-bdata-put-number"></a><h3>camel_util_bdata_put_number ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_util_bdata_put_number (<em class="parameter"><code><a href="../glib/glib-Strings.html#GString"><span class="type">GString</span></a> *bdata_str</code></em>,
                             <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> value</code></em>);</pre>
<p>Puts the number <em class="parameter"><code>value</code></em>
 at the end of the <em class="parameter"><code>bdata_str</code></em>
. In case the <em class="parameter"><code>bdata_str</code></em>

is not empty a space is added before the numeric <em class="parameter"><code>value</code></em>
. The stored value
can be read back with the <a class="link" href="camel-camel-utils.html#camel-util-bdata-get-number" title="camel_util_bdata_get_number ()"><code class="function">camel_util_bdata_get_number()</code></a>.</p>
<div class="refsect3">
<a name="camel-util-bdata-put-number.parameters"></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>bdata_str</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Strings.html#GString"><span class="type">GString</span></a> to store a backend specific data (bdata)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>a value to store</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-util-bdata-get-string"></a><h3>camel_util_bdata_get_string ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
camel_util_bdata_get_string (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **bdata_ptr</code></em>,
                             <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *default_value</code></em>);</pre>
<p>Reads a string data from the <em class="parameter"><code>bdata_ptr</code></em>
 and moves the <em class="parameter"><code>bdata_ptr</code></em>

after that string. If the string cannot be read, then the <em class="parameter"><code>default_value</code></em>

is returned instead and the <em class="parameter"><code>bdata_ptr</code></em>
 is left unchanged. The string
might be previously stored with the <a class="link" href="camel-camel-utils.html#camel-util-bdata-put-string" title="camel_util_bdata_put_string ()"><code class="function">camel_util_bdata_put_string()</code></a>.</p>
<div class="refsect3">
<a name="camel-util-bdata-get-string.parameters"></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>bdata_ptr</p></td>
<td class="parameter_description"><p>a backend specific data (bdata) pointer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>default_value</p></td>
<td class="parameter_description"><p>a value to return, when no data can be read</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-util-bdata-get-string.returns"></a><h4>Returns</h4>
<p>Newly allocated string, which was read, or
dupped the <em class="parameter"><code>default_value</code></em>
, if the <em class="parameter"><code>bdata_ptr</code></em>
doesn't point to a string.
Free returned pointer with <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when done with it. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-util-bdata-put-string"></a><h3>camel_util_bdata_put_string ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_util_bdata_put_string (<em class="parameter"><code><a href="../glib/glib-Strings.html#GString"><span class="type">GString</span></a> *bdata_str</code></em>,
                             <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
<p>Puts the string <em class="parameter"><code>value</code></em>
 at the end of the <em class="parameter"><code>bdata_str</code></em>
. In case the <em class="parameter"><code>bdata_str</code></em>

is not empty a space is added before the string <em class="parameter"><code>value</code></em>
. The stored value
can be read back with the <a class="link" href="camel-camel-utils.html#camel-util-bdata-get-string" title="camel_util_bdata_get_string ()"><code class="function">camel_util_bdata_get_string()</code></a>.</p>
<p>The strings are encoded as "length-value", quotes for clarity only.</p>
<div class="refsect3">
<a name="camel-util-bdata-put-string.parameters"></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>bdata_str</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Strings.html#GString"><span class="type">GString</span></a> to store a backend specific data (bdata)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>a value to store</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-time-value-apply"></a><h3>camel_time_value_apply ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span>
camel_time_value_apply (<em class="parameter"><code><span class="type">time_t</span> src_time</code></em>,
                        <em class="parameter"><code><a class="link" href="camel-camel-enums.html#CamelTimeUnit" title="enum CamelTimeUnit"><span class="type">CamelTimeUnit</span></a> unit</code></em>,
                        <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);</pre>
<p>Applies the given time <em class="parameter"><code>value</code></em>
 in unit <em class="parameter"><code>unit</code></em>
 to the <em class="parameter"><code>src_time</code></em>
.
Use negative value to subtract it. The time part is rounded
to the beginning of the day.</p>
<div class="refsect3">
<a name="camel-time-value-apply.parameters"></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>src_time</p></td>
<td class="parameter_description"><p>a time_t to apply the value to, or -1 to use the current time</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>unit</p></td>
<td class="parameter_description"><p>a <a class="link" href="camel-camel-enums.html#CamelTimeUnit" title="enum CamelTimeUnit"><span class="type">CamelTimeUnit</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>a value to apply</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-time-value-apply.returns"></a><h4>Returns</h4>
<p> <em class="parameter"><code>src_time</code></em>
modified by the given parameters as date, with
the time part being beginning of the day.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
</div>
<div class="refsect1">
<a name="camel-camel-utils.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.