/usr/share/gtk-doc/html/camel/CamelMedium.html is in libcamel1.2-dev 3.2.3-0ubuntu7.1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelMedium</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="MIME.html" title="MIME Objects">
<link rel="prev" href="CamelDataWrapper.html" title="CamelDataWrapper">
<link rel="next" href="CamelMimePart.html" title="CamelMimePart">
<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="CamelDataWrapper.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="MIME.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="CamelMimePart.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelMedium.synopsis" class="shortcut">Top</a>
|
<a href="#CamelMedium.description" class="shortcut">Description</a>
|
<a href="#CamelMedium.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelMedium"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelMedium.top_of_page"></a>CamelMedium</span></h2>
<p>CamelMedium</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelMedium.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="CamelMedium.html#CamelMedium-struct" title="struct CamelMedium">CamelMedium</a>;
<a class="link" href="CamelMedium.html#CamelMediumHeader" title="CamelMediumHeader">CamelMediumHeader</a>;
<span class="returnvalue">void</span> <a class="link" href="CamelMedium.html#camel-medium-add-header" title="camel_medium_add_header ()">camel_medium_add_header</a> (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> value</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelMedium.html#camel-medium-set-header" title="camel_medium_set_header ()">camel_medium_set_header</a> (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> value</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelMedium.html#camel-medium-remove-header" title="camel_medium_remove_header ()">camel_medium_remove_header</a> (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gconstpointer</span> <a class="link" href="CamelMedium.html#camel-medium-get-header" title="camel_medium_get_header ()">camel_medium_get_header</a> (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">GArray</span> * <a class="link" href="CamelMedium.html#camel-medium-get-headers" title="camel_medium_get_headers ()">camel_medium_get_headers</a> (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelMedium.html#camel-medium-free-headers" title="camel_medium_free_headers ()">camel_medium_free_headers</a> (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
<em class="parameter"><code><span class="type">GArray</span> *headers</code></em>);
<a class="link" href="CamelDataWrapper.html" title="CamelDataWrapper"><span class="returnvalue">CamelDataWrapper</span></a> * <a class="link" href="CamelMedium.html#camel-medium-get-content" title="camel_medium_get_content ()">camel_medium_get_content</a> (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelMedium.html#camel-medium-set-content" title="camel_medium_set_content ()">camel_medium_set_content</a> (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
<em class="parameter"><code><a class="link" href="CamelDataWrapper.html" title="CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> *content</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelMedium.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
+----<a class="link" href="CamelDataWrapper.html" title="CamelDataWrapper">CamelDataWrapper</a>
+----CamelMedium
+----<a class="link" href="CamelMimePart.html" title="CamelMimePart">CamelMimePart</a>
</pre>
</div>
<div class="refsect1">
<a name="CamelMedium.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CamelMedium.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelMedium-struct"></a><h3>struct CamelMedium</h3>
<pre class="programlisting">struct CamelMedium;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelMediumHeader"></a><h3>CamelMediumHeader</h3>
<pre class="programlisting">typedef struct {
const gchar *name;
const gchar *value;
} CamelMediumHeader;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-medium-add-header"></a><h3>camel_medium_add_header ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_medium_add_header (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> value</code></em>);</pre>
<p>
Adds a header to a <a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</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>medium</code></em> :</span></p></td>
<td>a <a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>name of the header</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>value of the header</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-medium-set-header"></a><h3>camel_medium_set_header ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_medium_set_header (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> value</code></em>);</pre>
<p>
Sets the value of a header. Any other occurances of the header
will be removed. Setting a <code class="literal">NULL</code> header can be used to remove
the header also.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>medium</code></em> :</span></p></td>
<td>a <a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>name of the header</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>value of the header</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-medium-remove-header"></a><h3>camel_medium_remove_header ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_medium_remove_header (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Removes the named header from the medium. All occurances of the
header are removed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>medium</code></em> :</span></p></td>
<td>a <a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the name of the header</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-medium-get-header"></a><h3>camel_medium_get_header ()</h3>
<pre class="programlisting"><span class="returnvalue">gconstpointer</span> camel_medium_get_header (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Gets the value of the named header in the medium, or <code class="literal">NULL</code> if
it is unset. The caller should not modify or free the data.
</p>
<p>
If the header occurs more than once, only retrieve the first
instance of the header. For multi-occuring headers, use
:<code class="function">get_headers()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>medium</code></em> :</span></p></td>
<td>a <a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the name of the header</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value of the named header, or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-medium-get-headers"></a><h3>camel_medium_get_headers ()</h3>
<pre class="programlisting"><span class="returnvalue">GArray</span> * camel_medium_get_headers (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>);</pre>
<p>
Gets an array of all header name/value pairs (as
CamelMediumHeader structures). The values will be decoded
to UTF-8 for any headers that are recognized by Camel. The
caller should not modify the returned data.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>medium</code></em> :</span></p></td>
<td>a <a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the array of headers, which must be freed with
<a class="link" href="CamelMedium.html#camel-medium-free-headers" title="camel_medium_free_headers ()"><code class="function">camel_medium_free_headers()</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-medium-free-headers"></a><h3>camel_medium_free_headers ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_medium_free_headers (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
<em class="parameter"><code><span class="type">GArray</span> *headers</code></em>);</pre>
<p>
Frees <em class="parameter"><code>headers</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>medium</code></em> :</span></p></td>
<td>a <a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
<td>an array of headers returned from <a class="link" href="CamelMedium.html#camel-medium-get-headers" title="camel_medium_get_headers ()"><code class="function">camel_medium_get_headers()</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-medium-get-content"></a><h3>camel_medium_get_content ()</h3>
<pre class="programlisting"><a class="link" href="CamelDataWrapper.html" title="CamelDataWrapper"><span class="returnvalue">CamelDataWrapper</span></a> * camel_medium_get_content (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>);</pre>
<p>
Gets a data wrapper that represents the content of the medium,
without its headers.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>medium</code></em> :</span></p></td>
<td>a <a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="CamelDataWrapper.html" title="CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> containing <em class="parameter"><code>medium</code></em>'s content. Can return NULL.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-medium-set-content"></a><h3>camel_medium_set_content ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_medium_set_content (<em class="parameter"><code><a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> *medium</code></em>,
<em class="parameter"><code><a class="link" href="CamelDataWrapper.html" title="CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> *content</code></em>);</pre>
<p>
Sets the content of <em class="parameter"><code>medium</code></em> to be <em class="parameter"><code>content</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>medium</code></em> :</span></p></td>
<td>a <a class="link" href="CamelMedium.html" title="CamelMedium"><span class="type">CamelMedium</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>content</code></em> :</span></p></td>
<td>a <a class="link" href="CamelDataWrapper.html" title="CamelDataWrapper"><span class="type">CamelDataWrapper</span></a> object</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|