~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/camel/html/camel-CamelMedium.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>CamelMedium</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Camel Reference Manual">
8
8
<link rel="up" href="MIME.html" title="MIME Objects">
9
9
<link rel="prev" href="camel-CamelDataWrapper.html" title="CamelDataWrapper">
26
26
                  <a href="#camel-CamelMedium.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry" lang="en">
 
29
<div class="refentry" title="CamelMedium">
30
30
<a name="camel-CamelMedium"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv">
 
38
<div class="refsynopsisdiv" title="Synopsis">
39
39
<a name="camel-CamelMedium.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">struct              <a class="link" href="camel-CamelMedium.html#CamelMedium" title="struct CamelMedium">CamelMedium</a>;
41
41
                    <a class="link" href="camel-CamelMedium.html#CamelMediumHeader" title="CamelMediumHeader">CamelMediumHeader</a>;
57
57
                                                         <em class="parameter"><code><a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> *content</code></em>);
58
58
</pre>
59
59
</div>
60
 
<div class="refsect1" lang="en">
 
60
<div class="refsect1" title="Description">
61
61
<a name="camel-CamelMedium.description"></a><h2>Description</h2>
62
62
<p>
63
63
</p>
64
64
</div>
65
 
<div class="refsect1" lang="en">
 
65
<div class="refsect1" title="Details">
66
66
<a name="camel-CamelMedium.details"></a><h2>Details</h2>
67
 
<div class="refsect2" lang="en">
 
67
<div class="refsect2" title="struct CamelMedium">
68
68
<a name="CamelMedium"></a><h3>struct CamelMedium</h3>
69
69
<pre class="programlisting">struct CamelMedium {
70
70
        CamelDataWrapper parent_object;
80
80
</p>
81
81
</div>
82
82
<hr>
83
 
<div class="refsect2" lang="en">
 
83
<div class="refsect2" title="CamelMediumHeader">
84
84
<a name="CamelMediumHeader"></a><h3>CamelMediumHeader</h3>
85
85
<pre class="programlisting">typedef struct {
86
86
        const gchar *name;
91
91
</p>
92
92
</div>
93
93
<hr>
94
 
<div class="refsect2" lang="en">
 
94
<div class="refsect2" title="camel_medium_add_header ()">
95
95
<a name="camel-medium-add-header"></a><h3>camel_medium_add_header ()</h3>
96
96
<pre class="programlisting"><span class="returnvalue">void</span>                camel_medium_add_header             (<em class="parameter"><code><a class="link" href="camel-CamelMedium.html#CamelMedium" title="struct CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
97
97
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
98
98
                                                         <em class="parameter"><code><span class="type">gconstpointer</span> value</code></em>);</pre>
99
99
<p>
100
 
Adds a header to a <a class="link" href="camel-CamelMedium.html#CamelMedium" title="struct CamelMedium"><span class="type">CamelMedium</span></a>.</p>
 
100
Adds a header to a <a class="link" href="camel-CamelMedium.html#CamelMedium" title="struct CamelMedium"><span class="type">CamelMedium</span></a>.
 
101
</p>
101
102
<div class="variablelist"><table border="0">
102
103
<col align="left" valign="top">
103
104
<tbody>
120
121
</table></div>
121
122
</div>
122
123
<hr>
123
 
<div class="refsect2" lang="en">
 
124
<div class="refsect2" title="camel_medium_set_header ()">
124
125
<a name="camel-medium-set-header"></a><h3>camel_medium_set_header ()</h3>
125
126
<pre class="programlisting"><span class="returnvalue">void</span>                camel_medium_set_header             (<em class="parameter"><code><a class="link" href="camel-CamelMedium.html#CamelMedium" title="struct CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
126
127
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
128
129
<p>
129
130
Sets the value of a header.  Any other occurances of the header
130
131
will be removed.  Setting a <code class="literal">NULL</code> header can be used to remove
131
 
the header also.</p>
 
132
the header also.
 
133
</p>
132
134
<div class="variablelist"><table border="0">
133
135
<col align="left" valign="top">
134
136
<tbody>
151
153
</table></div>
152
154
</div>
153
155
<hr>
154
 
<div class="refsect2" lang="en">
 
156
<div class="refsect2" title="camel_medium_remove_header ()">
155
157
<a name="camel-medium-remove-header"></a><h3>camel_medium_remove_header ()</h3>
156
158
<pre class="programlisting"><span class="returnvalue">void</span>                camel_medium_remove_header          (<em class="parameter"><code><a class="link" href="camel-CamelMedium.html#CamelMedium" title="struct CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
157
159
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
158
160
<p>
159
161
Removes the named header from the medium.  All occurances of the
160
 
header are removed.</p>
 
162
header are removed.
 
163
</p>
161
164
<div class="variablelist"><table border="0">
162
165
<col align="left" valign="top">
163
166
<tbody>
175
178
</table></div>
176
179
</div>
177
180
<hr>
178
 
<div class="refsect2" lang="en">
 
181
<div class="refsect2" title="camel_medium_get_header ()">
179
182
<a name="camel-medium-get-header"></a><h3>camel_medium_get_header ()</h3>
180
183
<pre class="programlisting"><span class="returnvalue">gconstpointer</span>       camel_medium_get_header             (<em class="parameter"><code><a class="link" href="camel-CamelMedium.html#CamelMedium" title="struct CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
181
184
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
186
189
<p>
187
190
If the header occurs more than once, only retrieve the first
188
191
instance of the header.  For multi-occuring headers, use
189
 
:<code class="function">get_headers()</code>.</p>
 
192
:<code class="function">get_headers()</code>.
 
193
</p>
190
194
<div class="variablelist"><table border="0">
191
195
<col align="left" valign="top">
192
196
<tbody>
209
213
</table></div>
210
214
</div>
211
215
<hr>
212
 
<div class="refsect2" lang="en">
 
216
<div class="refsect2" title="camel_medium_get_headers ()">
213
217
<a name="camel-medium-get-headers"></a><h3>camel_medium_get_headers ()</h3>
214
218
<pre class="programlisting"><span class="returnvalue">GArray</span> *            camel_medium_get_headers            (<em class="parameter"><code><a class="link" href="camel-CamelMedium.html#CamelMedium" title="struct CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>);</pre>
215
219
<p>
216
220
Gets an array of all header name/value pairs (as
217
221
CamelMediumHeader structures). The values will be decoded
218
222
to UTF-8 for any headers that are recognized by Camel. The
219
 
caller should not modify the returned data.</p>
 
223
caller should not modify the returned data.
 
224
</p>
220
225
<div class="variablelist"><table border="0">
221
226
<col align="left" valign="top">
222
227
<tbody>
235
240
</table></div>
236
241
</div>
237
242
<hr>
238
 
<div class="refsect2" lang="en">
 
243
<div class="refsect2" title="camel_medium_free_headers ()">
239
244
<a name="camel-medium-free-headers"></a><h3>camel_medium_free_headers ()</h3>
240
245
<pre class="programlisting"><span class="returnvalue">void</span>                camel_medium_free_headers           (<em class="parameter"><code><a class="link" href="camel-CamelMedium.html#CamelMedium" title="struct CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
241
246
                                                         <em class="parameter"><code><span class="type">GArray</span> *headers</code></em>);</pre>
242
247
<p>
243
 
Frees <em class="parameter"><code>headers</code></em>.</p>
 
248
Frees <em class="parameter"><code>headers</code></em>.
 
249
</p>
244
250
<div class="variablelist"><table border="0">
245
251
<col align="left" valign="top">
246
252
<tbody>
258
264
</table></div>
259
265
</div>
260
266
<hr>
261
 
<div class="refsect2" lang="en">
 
267
<div class="refsect2" title="camel_medium_get_content_object ()">
262
268
<a name="camel-medium-get-content-object"></a><h3>camel_medium_get_content_object ()</h3>
263
269
<pre class="programlisting"><a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="returnvalue">CamelDataWrapper</span></a> *  camel_medium_get_content_object     (<em class="parameter"><code><a class="link" href="camel-CamelMedium.html#CamelMedium" title="struct CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>);</pre>
264
270
<p>
265
271
Gets a data wrapper that represents the content of the medium,
266
 
without its headers.</p>
 
272
without its headers.
 
273
</p>
267
274
<div class="variablelist"><table border="0">
268
275
<col align="left" valign="top">
269
276
<tbody>
281
288
</table></div>
282
289
</div>
283
290
<hr>
284
 
<div class="refsect2" lang="en">
 
291
<div class="refsect2" title="camel_medium_set_content_object ()">
285
292
<a name="camel-medium-set-content-object"></a><h3>camel_medium_set_content_object ()</h3>
286
293
<pre class="programlisting"><span class="returnvalue">void</span>                camel_medium_set_content_object     (<em class="parameter"><code><a class="link" href="camel-CamelMedium.html#CamelMedium" title="struct CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
287
294
                                                         <em class="parameter"><code><a class="link" href="camel-CamelDataWrapper.html#CamelDataWrapper" title="struct CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> *content</code></em>);</pre>
288
295
<p>
289
 
Sets the content of <em class="parameter"><code>medium</code></em> to be <em class="parameter"><code>content</code></em>.</p>
 
296
Sets the content of <em class="parameter"><code>medium</code></em> to be <em class="parameter"><code>content</code></em>.
 
297
</p>
290
298
<div class="variablelist"><table border="0">
291
299
<col align="left" valign="top">
292
300
<tbody>