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

This file is indexed.

/usr/share/gtk-doc/html/camel/camel-CamelOperation.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelOperation: 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-object-bag.html" title="camel-object-bag">
<link rel="next" href="camel-camel-url.html" title="camel-url">
<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-CamelOperation.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-object-bag.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="camel-camel-url.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="camel-CamelOperation"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-CamelOperation.top_of_page"></a>CamelOperation</span></h2>
<p>CamelOperation</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="camel-CamelOperation.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="../gio/GCancellable.html#GCancellable-struct"><span class="returnvalue">GCancellable</span></a> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelOperation.html#camel-operation-new" title="camel_operation_new ()">camel_operation_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../gio/GCancellable.html#GCancellable-struct"><span class="returnvalue">GCancellable</span></a> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelOperation.html#camel-operation-new-proxy" title="camel_operation_new_proxy ()">camel_operation_new_proxy</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-CamelOperation.html#camel-operation-cancel-all" title="camel_operation_cancel_all ()">camel_operation_cancel_all</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-CamelOperation.html#camel-operation-push-message" title="camel_operation_push_message ()">camel_operation_push_message</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-CamelOperation.html#camel-operation-pop-message" title="camel_operation_pop_message ()">camel_operation_pop_message</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-CamelOperation.html#camel-operation-progress" title="camel_operation_progress ()">camel_operation_progress</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="camel-CamelOperation.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="camel-CamelOperation.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="camel-operation-new"></a><h3>camel_operation_new ()</h3>
<pre class="programlisting"><a href="../gio/GCancellable.html#GCancellable-struct"><span class="returnvalue">GCancellable</span></a> *
camel_operation_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Create a new camel operation handle.  Camel operation handles can
be used in a multithreaded application (or a single operation
handle can be used in a non threaded appliation) to cancel running
operations and to obtain notification messages of the internal
status of messages.</p>
<div class="refsect3">
<a name="camel-operation-new.returns"></a><h4>Returns</h4>
<p>A new operation handle. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="camel-operation-new-proxy"></a><h3>camel_operation_new_proxy ()</h3>
<pre class="programlisting"><a href="../gio/GCancellable.html#GCancellable-struct"><span class="returnvalue">GCancellable</span></a> *
camel_operation_new_proxy (<em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>);</pre>
<p>Proxies the <em class="parameter"><code>cancellable</code></em>
 in a way that if it is cancelled,
then the returned cancellable is also cancelled, but when
the returned cancellable is cancelled, then it doesn't
influence the original cancellable. Other CamelOperation
actions being done on the returned cancellable are also
propagated to the <em class="parameter"><code>cancellable</code></em>
.</p>
<p>The passed-in <em class="parameter"><code>cancellable</code></em>
 can be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, in which case
a plain CamelOperation is returned.</p>
<p>This is useful when some operation can be cancelled from
elsewhere (like by a user), but also by the code on its own,
when it doesn't make sense to cancel also any larger operation
to which the passed-in cancellable belongs.</p>
<div class="refsect3">
<a name="camel-operation-new-proxy.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>cancellable</p></td>
<td class="parameter_description"><p>a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> to proxy. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-operation-new-proxy.returns"></a><h4>Returns</h4>
<p>A new operation handle, proxying <em class="parameter"><code>cancellable</code></em>
. </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-operation-cancel-all"></a><h3>camel_operation_cancel_all ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_operation_cancel_all (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Cancel all outstanding operations.</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-operation-push-message"></a><h3>camel_operation_push_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_operation_push_message (<em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                              <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
                              <em class="parameter"><code>...</code></em>);</pre>
<p>Call this function to describe an operation being performed.
Call <a class="link" href="camel-CamelOperation.html#camel-operation-progress" title="camel_operation_progress ()"><code class="function">camel_operation_progress()</code></a> to report progress on the operation.
Call <a class="link" href="camel-CamelOperation.html#camel-operation-pop-message" title="camel_operation_pop_message ()"><code class="function">camel_operation_pop_message()</code></a> when the operation is complete.</p>
<p>This function only works if <em class="parameter"><code>cancellable</code></em>
 is a <span class="type">CamelOperation</span> cast as a
<a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>.  If <em class="parameter"><code>cancellable</code></em>
 is a plain <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the
function does nothing and returns silently.</p>
<div class="refsect3">
<a name="camel-operation-push-message.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>cancellable</p></td>
<td class="parameter_description"><p>a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>a standard <code class="function">printf()</code> format string</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>the parameters to insert into the format string</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="camel-operation-pop-message"></a><h3>camel_operation_pop_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_operation_pop_message (<em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>);</pre>
<p>Pops the most recently pushed message.</p>
<p>This function only works if <em class="parameter"><code>cancellable</code></em>
 is a <span class="type">CamelOperation</span> cast as a
<a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>.  If <em class="parameter"><code>cancellable</code></em>
 is a plain <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the
function does nothing and returns silently.</p>
<div class="refsect3">
<a name="camel-operation-pop-message.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>cancellable</p></td>
<td class="parameter_description"><p>a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="camel-operation-progress"></a><h3>camel_operation_progress ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_operation_progress (<em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> percent</code></em>);</pre>
<p>Report progress on the current operation.  <em class="parameter"><code>percent</code></em>
 reports the current
percentage of completion, which should be in the range of 0 to 100.</p>
<p>This function only works if <em class="parameter"><code>cancellable</code></em>
 is a <span class="type">CamelOperation</span> cast as a
<a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>.  If <em class="parameter"><code>cancellable</code></em>
 is a plain <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the
function does nothing and returns silently.</p>
<div class="refsect3">
<a name="camel-operation-progress.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>cancellable</p></td>
<td class="parameter_description"><p>a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>percent</p></td>
<td class="parameter_description"><p>percent complete, 0 to 100.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="camel-CamelOperation.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.