docs/reference/html/SoupMultipart.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>SoupMultipart</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="libsoup Reference Manual">
   8 <link rel="up" href="ch02.html" title="Core API">
   9 <link rel="prev" href="libsoup-2.4-soup-method.html" title="soup-method">
  10 <link rel="next" href="SoupServer.html" title="SoupServer">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="libsoup-2.4-soup-method.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">libsoup Reference Manual</th>
  21 <td><a accesskey="n" href="SoupServer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#SoupMultipart.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#SoupMultipart.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#SoupMultipart.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="SoupMultipart"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="SoupMultipart.top_of_page"></a>SoupMultipart</span></h2>
  36 <p>SoupMultipart — multipart HTTP message bodies</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="SoupMultipart.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">
  43 #include &lt;libsoup/soup.h&gt;
  44
  45 typedef             <a class="link" href="SoupMultipart.html" title="SoupMultipart">SoupMultipart</a>;
  46 <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="returnvalue">SoupMultipart</span></a> *     <a class="link" href="SoupMultipart.html#soup-multipart-new" title="soup_multipart_new ()">soup_multipart_new</a>                  (<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>);
  47 <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="returnvalue">SoupMultipart</span></a> *     <a class="link" href="SoupMultipart.html#soup-multipart-new-from-message" title="soup_multipart_new_from_message ()">soup_multipart_new_from_message</a>     (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *headers</code></em>,
  48                                                          <em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>);
  49 <span class="returnvalue">void</span>                <a class="link" href="SoupMultipart.html#soup-multipart-free" title="soup_multipart_free ()">soup_multipart_free</a>                 (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>);
  50
  51 <span class="returnvalue">int</span>                 <a class="link" href="SoupMultipart.html#soup-multipart-get-length" title="soup_multipart_get_length ()">soup_multipart_get_length</a>           (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>);
  52 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="SoupMultipart.html#soup-multipart-get-part" title="soup_multipart_get_part ()">soup_multipart_get_part</a>             (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>,
  53                                                          <em class="parameter"><code><span class="type">int</span> part</code></em>,
  54                                                          <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> **headers</code></em>,
  55                                                          <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> **body</code></em>);
  56 <span class="returnvalue">void</span>                <a class="link" href="SoupMultipart.html#soup-multipart-append-part" title="soup_multipart_append_part ()">soup_multipart_append_part</a>          (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>,
  57                                                          <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *headers</code></em>,
  58                                                          <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *body</code></em>);
  59 <span class="returnvalue">void</span>                <a class="link" href="SoupMultipart.html#soup-multipart-append-form-string" title="soup_multipart_append_form_string ()">soup_multipart_append_form_string</a>   (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>,
  60                                                          <em class="parameter"><code>const <span class="type">char</span> *control_name</code></em>,
  61                                                          <em class="parameter"><code>const <span class="type">char</span> *data</code></em>);
  62 <span class="returnvalue">void</span>                <a class="link" href="SoupMultipart.html#soup-multipart-append-form-file" title="soup_multipart_append_form_file ()">soup_multipart_append_form_file</a>     (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>,
  63                                                          <em class="parameter"><code>const <span class="type">char</span> *control_name</code></em>,
  64                                                          <em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
  65                                                          <em class="parameter"><code>const <span class="type">char</span> *content_type</code></em>,
  66                                                          <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *body</code></em>);
  67 <span class="returnvalue">void</span>                <a class="link" href="SoupMultipart.html#soup-multipart-to-message" title="soup_multipart_to_message ()">soup_multipart_to_message</a>           (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>,
  68                                                          <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *dest_headers</code></em>,
  69                                                          <em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *dest_body</code></em>);
  70 </pre>
  71 </div>
  72 <div class="refsect1">
  73 <a name="SoupMultipart.object-hierarchy"></a><h2>Object Hierarchy</h2>
  74 <pre class="synopsis">
  75   GBoxed
  76    +----SoupMultipart
  77 </pre>
  78 </div>
  79 <div class="refsect1">
  80 <a name="SoupMultipart.description"></a><h2>Description</h2>
  81 </div>
  82 <div class="refsect1">
  83 <a name="SoupMultipart.details"></a><h2>Details</h2>
  84 <div class="refsect2">
  85 <a name="SoupMultipart"></a><h3>SoupMultipart</h3>
  86 <pre class="programlisting">typedef struct SoupMultipart SoupMultipart;
  87 </pre>
  88 <p>
  89 Represents a multipart HTTP message body, parsed according to the
  90 syntax of RFC 2046. Of particular interest to HTTP are
  91 <code class="literal">multipart/byte-ranges</code> and
  92 <code class="literal">multipart/form-data</code>.
  93 </p>
  94 <p>
  95 Although the headers of a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> body part will contain the
  96 full headers from that body part, libsoup does not interpret them
  97 according to MIME rules. For example, each body part is assumed to
  98 have "binary" Content-Transfer-Encoding, even if its headers
  99 explicitly state otherwise. In other words, don't try to use
 100 <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> for handling real MIME multiparts.
 101 </p>
 102 <p class="since">Since 2.26</p>
 103 </div>
 104 <hr>
 105 <div class="refsect2">
 106 <a name="soup-multipart-new"></a><h3>soup_multipart_new ()</h3>
 107 <pre class="programlisting"><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="returnvalue">SoupMultipart</span></a> *     soup_multipart_new                  (<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>);</pre>
 108 <p>
 109 Creates a new empty <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> with a randomly-generated
 110 boundary string. Note that <em class="parameter"><code>mime_type</code></em> must be the full MIME type,
 111 including "multipart/".
 112 </p>
 113 <div class="variablelist"><table border="0">
 114 <col align="left" valign="top">
 115 <tbody>
 116 <tr>
 117 <td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
 118 <td>the MIME type of the multipart to create.</td>
 119 </tr>
 120 <tr>
 121 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 122 <td>a new empty <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> of the given <em class="parameter"><code>mime_type</code></em>
 123 </td>
 124 </tr>
 125 </tbody>
 126 </table></div>
 127 <p class="since">Since 2.26</p>
 128 </div>
 129 <hr>
 130 <div class="refsect2">
 131 <a name="soup-multipart-new-from-message"></a><h3>soup_multipart_new_from_message ()</h3>
 132 <pre class="programlisting"><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="returnvalue">SoupMultipart</span></a> *     soup_multipart_new_from_message     (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *headers</code></em>,
 133                                                          <em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>);</pre>
 134 <p>
 135 Parses <em class="parameter"><code>headers</code></em> and <em class="parameter"><code>body</code></em> to form a new <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a>
 136 </p>
 137 <div class="variablelist"><table border="0">
 138 <col align="left" valign="top">
 139 <tbody>
 140 <tr>
 141 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 142 <td>the headers of the HTTP message to parse</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term"><em class="parameter"><code>body</code></em> :</span></p></td>
 146 <td>the body of the HTTP message to parse</td>
 147 </tr>
 148 <tr>
 149 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 150 <td>a new <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> (or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the message couldn't
 151 be parsed or wasn't multipart).</td>
 152 </tr>
 153 </tbody>
 154 </table></div>
 155 <p class="since">Since 2.26</p>
 156 </div>
 157 <hr>
 158 <div class="refsect2">
 159 <a name="soup-multipart-free"></a><h3>soup_multipart_free ()</h3>
 160 <pre class="programlisting"><span class="returnvalue">void</span>                soup_multipart_free                 (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>);</pre>
 161 <p>
 162 Frees <em class="parameter"><code>multipart</code></em>
 163 </p>
 164 <div class="variablelist"><table border="0">
 165 <col align="left" valign="top">
 166 <tbody><tr>
 167 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
 168 <td>a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a>
 169 </td>
 170 </tr></tbody>
 171 </table></div>
 172 <p class="since">Since 2.26</p>
 173 </div>
 174 <hr>
 175 <div class="refsect2">
 176 <a name="soup-multipart-get-length"></a><h3>soup_multipart_get_length ()</h3>
 177 <pre class="programlisting"><span class="returnvalue">int</span>                 soup_multipart_get_length           (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>);</pre>
 178 <p>
 179 Gets the number of body parts in <em class="parameter"><code>multipart</code></em>
 180 </p>
 181 <div class="variablelist"><table border="0">
 182 <col align="left" valign="top">
 183 <tbody>
 184 <tr>
 185 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
 186 <td>a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a>
 187 </td>
 188 </tr>
 189 <tr>
 190 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 191 <td>the number of body parts in <em class="parameter"><code>multipart</code></em>
 192 </td>
 193 </tr>
 194 </tbody>
 195 </table></div>
 196 <p class="since">Since 2.26</p>
 197 </div>
 198 <hr>
 199 <div class="refsect2">
 200 <a name="soup-multipart-get-part"></a><h3>soup_multipart_get_part ()</h3>
 201 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            soup_multipart_get_part             (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>,
 202                                                          <em class="parameter"><code><span class="type">int</span> part</code></em>,
 203                                                          <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> **headers</code></em>,
 204                                                          <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> **body</code></em>);</pre>
 205 <p>
 206 Gets the indicated body part from <em class="parameter"><code>multipart</code></em>.
 207 </p>
 208 <div class="variablelist"><table border="0">
 209 <col align="left" valign="top">
 210 <tbody>
 211 <tr>
 212 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
 213 <td>a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a>
 214 </td>
 215 </tr>
 216 <tr>
 217 <td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
 218 <td>the part number to get (counting from 0)</td>
 219 </tr>
 220 <tr>
 221 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 222 <td>return location for the MIME part
 223 headers. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 224 </td>
 225 </tr>
 226 <tr>
 227 <td><p><span class="term"><em class="parameter"><code>body</code></em> :</span></p></td>
 228 <td>return location for the MIME part
 229 body. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 230 </td>
 231 </tr>
 232 <tr>
 233 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 234 <td>
 235 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if <em class="parameter"><code>part</code></em> is out of range (in
 236 which case <em class="parameter"><code>headers</code></em> and <em class="parameter"><code>body</code></em> won't be set)</td>
 237 </tr>
 238 </tbody>
 239 </table></div>
 240 <p class="since">Since 2.26</p>
 241 </div>
 242 <hr>
 243 <div class="refsect2">
 244 <a name="soup-multipart-append-part"></a><h3>soup_multipart_append_part ()</h3>
 245 <pre class="programlisting"><span class="returnvalue">void</span>                soup_multipart_append_part          (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>,
 246                                                          <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *headers</code></em>,
 247                                                          <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *body</code></em>);</pre>
 248 <p>
 249 Adds a new MIME part to <em class="parameter"><code>multipart</code></em> with the given headers and body.
 250 (The multipart will make its own copies of <em class="parameter"><code>headers</code></em> and <em class="parameter"><code>body</code></em>, so
 251 you should free your copies if you are not using them for anything
 252 else.)
 253 </p>
 254 <div class="variablelist"><table border="0">
 255 <col align="left" valign="top">
 256 <tbody>
 257 <tr>
 258 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
 259 <td>a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a>
 260 </td>
 261 </tr>
 262 <tr>
 263 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 264 <td>the MIME part headers</td>
 265 </tr>
 266 <tr>
 267 <td><p><span class="term"><em class="parameter"><code>body</code></em> :</span></p></td>
 268 <td>the MIME part body</td>
 269 </tr>
 270 </tbody>
 271 </table></div>
 272 <p class="since">Since 2.26</p>
 273 </div>
 274 <hr>
 275 <div class="refsect2">
 276 <a name="soup-multipart-append-form-string"></a><h3>soup_multipart_append_form_string ()</h3>
 277 <pre class="programlisting"><span class="returnvalue">void</span>                soup_multipart_append_form_string   (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>,
 278                                                          <em class="parameter"><code>const <span class="type">char</span> *control_name</code></em>,
 279                                                          <em class="parameter"><code>const <span class="type">char</span> *data</code></em>);</pre>
 280 <p>
 281 Adds a new MIME part containing <em class="parameter"><code>data</code></em> to <em class="parameter"><code>multipart</code></em>, using
 282 "Content-Disposition: form-data", as per the HTML forms
 283 specification. See <a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new-from-multipart" title="soup_form_request_new_from_multipart ()"><code class="function">soup_form_request_new_from_multipart()</code></a> for more
 284 details.
 285 </p>
 286 <div class="variablelist"><table border="0">
 287 <col align="left" valign="top">
 288 <tbody>
 289 <tr>
 290 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
 291 <td>a multipart (presumably of type "multipart/form-data")</td>
 292 </tr>
 293 <tr>
 294 <td><p><span class="term"><em class="parameter"><code>control_name</code></em> :</span></p></td>
 295 <td>the name of the control associated with <em class="parameter"><code>data</code></em>
 296 </td>
 297 </tr>
 298 <tr>
 299 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 300 <td>the body data</td>
 301 </tr>
 302 </tbody>
 303 </table></div>
 304 <p class="since">Since 2.26</p>
 305 </div>
 306 <hr>
 307 <div class="refsect2">
 308 <a name="soup-multipart-append-form-file"></a><h3>soup_multipart_append_form_file ()</h3>
 309 <pre class="programlisting"><span class="returnvalue">void</span>                soup_multipart_append_form_file     (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>,
 310                                                          <em class="parameter"><code>const <span class="type">char</span> *control_name</code></em>,
 311                                                          <em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
 312                                                          <em class="parameter"><code>const <span class="type">char</span> *content_type</code></em>,
 313                                                          <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *body</code></em>);</pre>
 314 <p>
 315 Adds a new MIME part containing <em class="parameter"><code>body</code></em> to <em class="parameter"><code>multipart</code></em>, using
 316 "Content-Disposition: form-data", as per the HTML forms
 317 specification. See <a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new-from-multipart" title="soup_form_request_new_from_multipart ()"><code class="function">soup_form_request_new_from_multipart()</code></a> for more
 318 details.
 319 </p>
 320 <div class="variablelist"><table border="0">
 321 <col align="left" valign="top">
 322 <tbody>
 323 <tr>
 324 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
 325 <td>a multipart (presumably of type "multipart/form-data")</td>
 326 </tr>
 327 <tr>
 328 <td><p><span class="term"><em class="parameter"><code>control_name</code></em> :</span></p></td>
 329 <td>the name of the control associated with this file</td>
 330 </tr>
 331 <tr>
 332 <td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
 333 <td>the name of the file, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not known</td>
 334 </tr>
 335 <tr>
 336 <td><p><span class="term"><em class="parameter"><code>content_type</code></em> :</span></p></td>
 337 <td>the MIME type of the file, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not known</td>
 338 </tr>
 339 <tr>
 340 <td><p><span class="term"><em class="parameter"><code>body</code></em> :</span></p></td>
 341 <td>the file data</td>
 342 </tr>
 343 </tbody>
 344 </table></div>
 345 <p class="since">Since 2.26</p>
 346 </div>
 347 <hr>
 348 <div class="refsect2">
 349 <a name="soup-multipart-to-message"></a><h3>soup_multipart_to_message ()</h3>
 350 <pre class="programlisting"><span class="returnvalue">void</span>                soup_multipart_to_message           (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>,
 351                                                          <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *dest_headers</code></em>,
 352                                                          <em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *dest_body</code></em>);</pre>
 353 <p>
 354 Serializes <em class="parameter"><code>multipart</code></em> to <em class="parameter"><code>dest_headers</code></em> and <em class="parameter"><code>dest_body</code></em>.
 355 </p>
 356 <div class="variablelist"><table border="0">
 357 <col align="left" valign="top">
 358 <tbody>
 359 <tr>
 360 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
 361 <td>a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a>
 362 </td>
 363 </tr>
 364 <tr>
 365 <td><p><span class="term"><em class="parameter"><code>dest_headers</code></em> :</span></p></td>
 366 <td>the headers of the HTTP message to serialize <em class="parameter"><code>multipart</code></em> to</td>
 367 </tr>
 368 <tr>
 369 <td><p><span class="term"><em class="parameter"><code>dest_body</code></em> :</span></p></td>
 370 <td>the body of the HTTP message to serialize <em class="parameter"><code>multipart</code></em> to</td>
 371 </tr>
 372 </tbody>
 373 </table></div>
 374 <p class="since">Since 2.26</p>
 375 </div>
 376 </div>
 377 <div class="refsect1">
 378 <a name="SoupMultipart.see-also"></a><h2>See Also</h2>
 379 <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a>, <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a>
 380 </div>
 381 </div>
 382 <div class="footer">
 383 <hr>
 384           Generated by GTK-Doc V1.18</div>
 385 </body>
 386 </html>