File: CamelMimeFilterProgress.html

package info (click to toggle)
evolution-data-server 3.4.4-3%2Bdeb7u1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 47,788 kB
  • sloc: ansic: 248,622; sh: 12,008; makefile: 2,874; xml: 428; perl: 204; python: 30
file content (103 lines) | stat: -rw-r--r-- 6,422 bytes parent folder | download 
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
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelMimeFilterProgress</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Stream-Filters.html" title="Stream Filters">
<link rel="prev" href="CamelMimeFilterPgp.html" title="CamelMimeFilterPgp">
<link rel="next" href="CamelMimeFilterSave.html" title="CamelMimeFilterSave">
<meta name="generator" content="GTK-Doc V1.18 (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="CamelMimeFilterPgp.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Stream-Filters.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="CamelMimeFilterSave.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelMimeFilterProgress.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#CamelMimeFilterProgress.description" class="shortcut">Description</a>
                   | 
                  <a href="#CamelMimeFilterProgress.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelMimeFilterProgress"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelMimeFilterProgress.top_of_page"></a>CamelMimeFilterProgress</span></h2>
<p>CamelMimeFilterProgress</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelMimeFilterProgress.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="CamelMimeFilterProgress.html#CamelMimeFilterProgress-struct" title="struct CamelMimeFilterProgress">CamelMimeFilterProgress</a>;
<a class="link" href="CamelMimeFilter.html" title="CamelMimeFilter"><span class="returnvalue">CamelMimeFilter</span></a> *   <a class="link" href="CamelMimeFilterProgress.html#camel-mime-filter-progress-new" title="camel_mime_filter_progress_new ()">camel_mime_filter_progress_new</a>      (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                                         <em class="parameter"><code><span class="type">gsize</span> total</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelMimeFilterProgress.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
         +----<a class="link" href="CamelMimeFilter.html" title="CamelMimeFilter">CamelMimeFilter</a>
               +----CamelMimeFilterProgress
</pre>
</div>
<div class="refsect1">
<a name="CamelMimeFilterProgress.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="CamelMimeFilterProgress.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelMimeFilterProgress-struct"></a><h3>struct CamelMimeFilterProgress</h3>
<pre class="programlisting">struct CamelMimeFilterProgress;</pre>
<p class="since">Since 2.24</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-filter-progress-new"></a><h3>camel_mime_filter_progress_new ()</h3>
<pre class="programlisting"><a class="link" href="CamelMimeFilter.html" title="CamelMimeFilter"><span class="returnvalue">CamelMimeFilter</span></a> *   camel_mime_filter_progress_new      (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                                         <em class="parameter"><code><span class="type">gsize</span> total</code></em>);</pre>
<p>
Create a new <a class="link" href="CamelMimeFilterProgress.html" title="CamelMimeFilterProgress"><span class="type">CamelMimeFilterProgress</span></a> object that will report streaming
progress.  While the function will silently accept <em class="parameter"><code>cancellable</code></em> being
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or a plain <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> for convenience sake, no progress will be
reported unless <em class="parameter"><code>cancellable</code></em> is a <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a> cast as a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>total</code></em> :</span></p></td>
<td>total number of bytes to report progress on</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="CamelMimeFilter.html" title="CamelMimeFilter"><span class="type">CamelMimeFilter</span></a> object</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.24</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>