diff options
Diffstat (limited to 'docs/reference/html/SoupMultipart.html')
| -rw-r--r-- | docs/reference/html/SoupMultipart.html | 537 |
1 files changed, 537 insertions, 0 deletions
diff --git a/docs/reference/html/SoupMultipart.html b/docs/reference/html/SoupMultipart.html new file mode 100644 index 00000000..25580672 --- /dev/null +++ b/docs/reference/html/SoupMultipart.html @@ -0,0 +1,537 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>libsoup Reference Manual: SoupMultipart</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="libsoup Reference Manual"> +<link rel="up" href="ch02.html" title="Core API"> +<link rel="prev" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html" title="Soup Miscellaneous Utilities"> +<link rel="next" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"> +<meta name="generator" content="GTK-Doc V1.20 (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="10"><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="#SoupMultipart.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SoupMultipart.object-hierarchy" class="shortcut">Object Hierarchy</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SoupMultipartInputStream.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SoupMultipart"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SoupMultipart.top_of_page"></a>SoupMultipart</span></h2> +<p>SoupMultipart — multipart HTTP message bodies</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SoupMultipart.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="returnvalue">SoupMultipart</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SoupMultipart.html#soup-multipart-new" title="soup_multipart_new ()">soup_multipart_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="returnvalue">SoupMultipart</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SoupMultipart.html#soup-multipart-new-from-message" title="soup_multipart_new_from_message ()">soup_multipart_new_from_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="SoupMultipart.html#soup-multipart-free" title="soup_multipart_free ()">soup_multipart_free</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="SoupMultipart.html#soup-multipart-get-length" title="soup_multipart_get_length ()">soup_multipart_get_length</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="SoupMultipart.html#soup-multipart-get-part" title="soup_multipart_get_part ()">soup_multipart_get_part</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="SoupMultipart.html#soup-multipart-append-part" title="soup_multipart_append_part ()">soup_multipart_append_part</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="SoupMultipart.html#soup-multipart-append-form-string" title="soup_multipart_append_form_string ()">soup_multipart_append_form_string</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="SoupMultipart.html#soup-multipart-append-form-file" title="soup_multipart_append_form_file ()">soup_multipart_append_form_file</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="SoupMultipart.html#soup-multipart-to-message" title="soup_multipart_to_message ()">soup_multipart_to_message</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SoupMultipart.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody><tr> +<td class="typedef_keyword">typedef</td> +<td class="function_name"><a class="link" href="SoupMultipart.html" title="SoupMultipart">SoupMultipart</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SoupMultipart.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> GBoxed + <span class="lineart">╰──</span> SoupMultipart +</pre> +</div> +<div class="refsect1"> +<a name="SoupMultipart.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <libsoup/soup.h> +</pre> +</div> +<div class="refsect1"> +<a name="SoupMultipart.description"></a><h2>Description</h2> +</div> +<div class="refsect1"> +<a name="SoupMultipart.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="soup-multipart-new"></a><h3>soup_multipart_new ()</h3> +<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> +<p>Creates a new empty <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> with a randomly-generated +boundary string. Note that <em class="parameter"><code>mime_type</code></em> + must be the full MIME type, +including "multipart/".</p> +<div class="refsect3"> +<a name="id-1.3.13.8.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>mime_type</p></td> +<td class="parameter_description"><p>the MIME type of the multipart to create.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.13.8.2.6"></a><h4>Returns</h4> +<p> 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> +</p> +<p></p> +</div> +<p class="since">Since 2.26</p> +</div> +<hr> +<div class="refsect2"> +<a name="soup-multipart-new-from-message"></a><h3>soup_multipart_new_from_message ()</h3> +<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>, + <em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>);</pre> +<p>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></p> +<div class="refsect3"> +<a name="id-1.3.13.8.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>headers</p></td> +<td class="parameter_description"><p>the headers of the HTTP message to parse</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>body</p></td> +<td class="parameter_description"><p>the body of the HTTP message to parse</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.13.8.3.6"></a><h4>Returns</h4> +<p> 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 +be parsed or wasn't multipart).</p> +<p></p> +</div> +<p class="since">Since 2.26</p> +</div> +<hr> +<div class="refsect2"> +<a name="soup-multipart-free"></a><h3>soup_multipart_free ()</h3> +<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> +<p>Frees <em class="parameter"><code>multipart</code></em> +</p> +<div class="refsect3"> +<a name="id-1.3.13.8.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>multipart</p></td> +<td class="parameter_description"><p>a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<p class="since">Since 2.26</p> +</div> +<hr> +<div class="refsect2"> +<a name="soup-multipart-get-length"></a><h3>soup_multipart_get_length ()</h3> +<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> +<p>Gets the number of body parts in <em class="parameter"><code>multipart</code></em> +</p> +<div class="refsect3"> +<a name="id-1.3.13.8.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>multipart</p></td> +<td class="parameter_description"><p>a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.13.8.5.6"></a><h4>Returns</h4> +<p> the number of body parts in <em class="parameter"><code>multipart</code></em> +</p> +<p></p> +</div> +<p class="since">Since 2.26</p> +</div> +<hr> +<div class="refsect2"> +<a name="soup-multipart-get-part"></a><h3>soup_multipart_get_part ()</h3> +<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>, + <em class="parameter"><code><span class="type">int</span> part</code></em>, + <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> **headers</code></em>, + <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> **body</code></em>);</pre> +<p>Gets the indicated body part from <em class="parameter"><code>multipart</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.3.13.8.6.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>multipart</p></td> +<td class="parameter_description"><p>a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>part</p></td> +<td class="parameter_description"><p>the part number to get (counting from 0)</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>headers</p></td> +<td class="parameter_description"><p> return location for the MIME part +headers. </p></td> +<td class="parameter_annotations"><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></td> +</tr> +<tr> +<td class="parameter_name"><p>body</p></td> +<td class="parameter_description"><p> return location for the MIME part +body. </p></td> +<td class="parameter_annotations"><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></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.13.8.6.6"></a><h4>Returns</h4> +<p> <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 +which case <em class="parameter"><code>headers</code></em> +and <em class="parameter"><code>body</code></em> +won't be set)</p> +<p></p> +</div> +<p class="since">Since 2.26</p> +</div> +<hr> +<div class="refsect2"> +<a name="soup-multipart-append-part"></a><h3>soup_multipart_append_part ()</h3> +<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>, + <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *headers</code></em>, + <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *body</code></em>);</pre> +<p>Adds a new MIME part to <em class="parameter"><code>multipart</code></em> + with the given headers and body. +(The multipart will make its own copies of <em class="parameter"><code>headers</code></em> + and <em class="parameter"><code>body</code></em> +, so +you should free your copies if you are not using them for anything +else.)</p> +<div class="refsect3"> +<a name="id-1.3.13.8.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>multipart</p></td> +<td class="parameter_description"><p>a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>headers</p></td> +<td class="parameter_description"><p>the MIME part headers</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>body</p></td> +<td class="parameter_description"><p>the MIME part body</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since 2.26</p> +</div> +<hr> +<div class="refsect2"> +<a name="soup-multipart-append-form-string"></a><h3>soup_multipart_append_form_string ()</h3> +<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>, + <em class="parameter"><code>const <span class="type">char</span> *control_name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *data</code></em>);</pre> +<p>Adds a new MIME part containing <em class="parameter"><code>data</code></em> + to <em class="parameter"><code>multipart</code></em> +, using +"Content-Disposition: form-data", as per the HTML forms +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 +details.</p> +<div class="refsect3"> +<a name="id-1.3.13.8.8.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>multipart</p></td> +<td class="parameter_description"><p>a multipart (presumably of type "multipart/form-data")</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>control_name</p></td> +<td class="parameter_description"><p>the name of the control associated with <em class="parameter"><code>data</code></em> +</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>the body data</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since 2.26</p> +</div> +<hr> +<div class="refsect2"> +<a name="soup-multipart-append-form-file"></a><h3>soup_multipart_append_form_file ()</h3> +<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>, + <em class="parameter"><code>const <span class="type">char</span> *control_name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *content_type</code></em>, + <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *body</code></em>);</pre> +<p>Adds a new MIME part containing <em class="parameter"><code>body</code></em> + to <em class="parameter"><code>multipart</code></em> +, using +"Content-Disposition: form-data", as per the HTML forms +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 +details.</p> +<div class="refsect3"> +<a name="id-1.3.13.8.9.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>multipart</p></td> +<td class="parameter_description"><p>a multipart (presumably of type "multipart/form-data")</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>control_name</p></td> +<td class="parameter_description"><p>the name of the control associated with this file</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>filename</p></td> +<td class="parameter_description"><p>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</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>content_type</p></td> +<td class="parameter_description"><p>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</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>body</p></td> +<td class="parameter_description"><p>the file data</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since 2.26</p> +</div> +<hr> +<div class="refsect2"> +<a name="soup-multipart-to-message"></a><h3>soup_multipart_to_message ()</h3> +<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>, + <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *dest_headers</code></em>, + <em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *dest_body</code></em>);</pre> +<p>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> +.</p> +<div class="refsect3"> +<a name="id-1.3.13.8.10.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>multipart</p></td> +<td class="parameter_description"><p>a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>dest_headers</p></td> +<td class="parameter_description"><p>the headers of the HTTP message to serialize <em class="parameter"><code>multipart</code></em> +to</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>dest_body</p></td> +<td class="parameter_description"><p>the body of the HTTP message to serialize <em class="parameter"><code>multipart</code></em> +to</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since 2.26</p> +</div> +</div> +<div class="refsect1"> +<a name="SoupMultipart.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SoupMultipart"></a><h3>SoupMultipart</h3> +<pre class="programlisting">typedef struct SoupMultipart SoupMultipart; +</pre> +<p>Represents a multipart HTTP message body, parsed according to the +syntax of RFC 2046. Of particular interest to HTTP are +<code class="literal">multipart/byte-ranges</code> and +<code class="literal">multipart/form-data</code>.</p> +<p>Although the headers of a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> body part will contain the +full headers from that body part, libsoup does not interpret them +according to MIME rules. For example, each body part is assumed to +have "binary" Content-Transfer-Encoding, even if its headers +explicitly state otherwise. In other words, don't try to use +<a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> for handling real MIME multiparts.</p> +<p class="since">Since 2.26</p> +</div> +</div> +<div class="refsect1"> +<a name="SoupMultipart.see-also"></a><h2>See Also</h2> +<p><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></p> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.20</div> +</body> +</html>
\ No newline at end of file |