docs/reference/html/GMimeDataWrapper.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>GMimeDataWrapper</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GMime 2.6 Reference Manual">
   8 <link rel="up" href="DataWrappers.html" title="Data Wrappers">
   9 <link rel="prev" href="DataWrappers.html" title="Data Wrappers">
  10 <link rel="next" href="Headers.html" title="Message and MIME Headers">
  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="DataWrappers.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="DataWrappers.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">GMime 2.6 Reference Manual</th>
  21 <td><a accesskey="n" href="Headers.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="#GMimeDataWrapper.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeDataWrapper.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeDataWrapper.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeDataWrapper"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeDataWrapper.top_of_page"></a>GMimeDataWrapper</span></h2>
  36 <p>GMimeDataWrapper — Content objects</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeDataWrapper.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GMimeDataWrapper.html#GMimeDataWrapper-struct" title="struct GMimeDataWrapper">GMimeDataWrapper</a>;
  43 <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="returnvalue">GMimeDataWrapper</span></a> *  <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-new" title="g_mime_data_wrapper_new ()">g_mime_data_wrapper_new</a>             (<em class="parameter"><code><span class="type">void</span></code></em>);
  44 <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="returnvalue">GMimeDataWrapper</span></a> *  <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-new-with-stream" title="g_mime_data_wrapper_new_with_stream ()">g_mime_data_wrapper_new_with_stream</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>,
  45                                                          <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> encoding</code></em>);
  46 <span class="returnvalue">void</span>                <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-set-stream" title="g_mime_data_wrapper_set_stream ()">g_mime_data_wrapper_set_stream</a>      (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>,
  47                                                          <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);
  48 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-get-stream" title="g_mime_data_wrapper_get_stream ()">g_mime_data_wrapper_get_stream</a>      (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>);
  49 <span class="returnvalue">void</span>                <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-set-encoding" title="g_mime_data_wrapper_set_encoding ()">g_mime_data_wrapper_set_encoding</a>    (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>,
  50                                                          <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> encoding</code></em>);
  51 <a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a> <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-get-encoding" title="g_mime_data_wrapper_get_encoding ()">g_mime_data_wrapper_get_encoding</a>   (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>);
  52 <span class="returnvalue">ssize_t</span>             <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-write-to-stream" title="g_mime_data_wrapper_write_to_stream ()">g_mime_data_wrapper_write_to_stream</a> (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>,
  53                                                          <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="GMimeDataWrapper.object-hierarchy"></a><h2>Object Hierarchy</h2>
  58 <pre class="synopsis">
  59   GObject
  60    +----GMimeDataWrapper
  61 </pre>
  62 </div>
  63 <div class="refsect1">
  64 <a name="GMimeDataWrapper.description"></a><h2>Description</h2>
  65 <p>
  66 A <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> is a wrapper object for a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a>'s body,
  67 allowing clients to read the content from the backing stream
  68 without having to know whether it is encoded/compressed/etc and not
  69 neding to know how to undo said encoding(s).
  70 </p>
  71 </div>
  72 <div class="refsect1">
  73 <a name="GMimeDataWrapper.details"></a><h2>Details</h2>
  74 <div class="refsect2">
  75 <a name="GMimeDataWrapper-struct"></a><h3>struct GMimeDataWrapper</h3>
  76 <pre class="programlisting">struct GMimeDataWrapper;</pre>
  77 <p>
  78 A wrapper for a stream which may be encoded.
  79 </p>
  80 <div class="variablelist"><table border="0">
  81 <col align="left" valign="top">
  82 <tbody></tbody>
  83 </table></div>
  84 </div>
  85 <hr>
  86 <div class="refsect2">
  87 <a name="g-mime-data-wrapper-new"></a><h3>g_mime_data_wrapper_new ()</h3>
  88 <pre class="programlisting"><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="returnvalue">GMimeDataWrapper</span></a> *  g_mime_data_wrapper_new             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
  89 <p>
  90 Creates a new <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> object.
  91 </p>
  92 <div class="variablelist"><table border="0">
  93 <col align="left" valign="top">
  94 <tbody><tr>
  95 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  96 <td>a new data wrapper object.</td>
  97 </tr></tbody>
  98 </table></div>
  99 </div>
 100 <hr>
 101 <div class="refsect2">
 102 <a name="g-mime-data-wrapper-new-with-stream"></a><h3>g_mime_data_wrapper_new_with_stream ()</h3>
 103 <pre class="programlisting"><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="returnvalue">GMimeDataWrapper</span></a> *  g_mime_data_wrapper_new_with_stream (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>,
 104                                                          <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> encoding</code></em>);</pre>
 105 <p>
 106 Creates a new <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> object around <em class="parameter"><code>stream</code></em>.
 107 </p>
 108 <div class="variablelist"><table border="0">
 109 <col align="left" valign="top">
 110 <tbody>
 111 <tr>
 112 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 113 <td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a>
 114 </td>
 115 </tr>
 116 <tr>
 117 <td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td>
 118 <td>stream's encoding</td>
 119 </tr>
 120 <tr>
 121 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 122 <td>a data wrapper around <em class="parameter"><code>stream</code></em>. Since the wrapper owns its
 123 own reference on the stream, caller is responsible for unrefing
 124 its own copy.</td>
 125 </tr>
 126 </tbody>
 127 </table></div>
 128 </div>
 129 <hr>
 130 <div class="refsect2">
 131 <a name="g-mime-data-wrapper-set-stream"></a><h3>g_mime_data_wrapper_set_stream ()</h3>
 132 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_data_wrapper_set_stream      (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>,
 133                                                          <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre>
 134 <p>
 135 Replaces the wrapper's internal stream with <em class="parameter"><code>stream</code></em>. Don't forget,
 136 if <em class="parameter"><code>stream</code></em> is not of the same encoding as the old stream, you'll
 137 want to call <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-set-encoding" title="g_mime_data_wrapper_set_encoding ()"><code class="function">g_mime_data_wrapper_set_encoding()</code></a> as well.
 138 </p>
 139 <p>
 140 Note: caller is responsible for its own reference on
 141 <em class="parameter"><code>stream</code></em>.
 142 </p>
 143 <div class="variablelist"><table border="0">
 144 <col align="left" valign="top">
 145 <tbody>
 146 <tr>
 147 <td><p><span class="term"><em class="parameter"><code>wrapper</code></em> :</span></p></td>
 148 <td>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a>
 149 </td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 153 <td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a>
 154 </td>
 155 </tr>
 156 </tbody>
 157 </table></div>
 158 </div>
 159 <hr>
 160 <div class="refsect2">
 161 <a name="g-mime-data-wrapper-get-stream"></a><h3>g_mime_data_wrapper_get_stream ()</h3>
 162 <pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       g_mime_data_wrapper_get_stream      (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>);</pre>
 163 <p>
 164 Gets a reference to the stream wrapped by <em class="parameter"><code>wrapper</code></em>.
 165 </p>
 166 <div class="variablelist"><table border="0">
 167 <col align="left" valign="top">
 168 <tbody>
 169 <tr>
 170 <td><p><span class="term"><em class="parameter"><code>wrapper</code></em> :</span></p></td>
 171 <td>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a>
 172 </td>
 173 </tr>
 174 <tr>
 175 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 176 <td>a reference to the internal stream.</td>
 177 </tr>
 178 </tbody>
 179 </table></div>
 180 </div>
 181 <hr>
 182 <div class="refsect2">
 183 <a name="g-mime-data-wrapper-set-encoding"></a><h3>g_mime_data_wrapper_set_encoding ()</h3>
 184 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_data_wrapper_set_encoding    (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>,
 185                                                          <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> encoding</code></em>);</pre>
 186 <p>
 187 Sets the encoding type of the internal stream.
 188 </p>
 189 <div class="variablelist"><table border="0">
 190 <col align="left" valign="top">
 191 <tbody>
 192 <tr>
 193 <td><p><span class="term"><em class="parameter"><code>wrapper</code></em> :</span></p></td>
 194 <td>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a>
 195 </td>
 196 </tr>
 197 <tr>
 198 <td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td>
 199 <td>encoding</td>
 200 </tr>
 201 </tbody>
 202 </table></div>
 203 </div>
 204 <hr>
 205 <div class="refsect2">
 206 <a name="g-mime-data-wrapper-get-encoding"></a><h3>g_mime_data_wrapper_get_encoding ()</h3>
 207 <pre class="programlisting"><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a> g_mime_data_wrapper_get_encoding   (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>);</pre>
 208 <p>
 209 Gets the encoding type of the stream wrapped by <em class="parameter"><code>wrapper</code></em>.
 210 </p>
 211 <div class="variablelist"><table border="0">
 212 <col align="left" valign="top">
 213 <tbody>
 214 <tr>
 215 <td><p><span class="term"><em class="parameter"><code>wrapper</code></em> :</span></p></td>
 216 <td>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a>
 217 </td>
 218 </tr>
 219 <tr>
 220 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 221 <td>the encoding type of the internal stream.</td>
 222 </tr>
 223 </tbody>
 224 </table></div>
 225 </div>
 226 <hr>
 227 <div class="refsect2">
 228 <a name="g-mime-data-wrapper-write-to-stream"></a><h3>g_mime_data_wrapper_write_to_stream ()</h3>
 229 <pre class="programlisting"><span class="returnvalue">ssize_t</span>             g_mime_data_wrapper_write_to_stream (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>,
 230                                                          <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre>
 231 <p>
 232 Writes the raw (decoded) data to the output stream.
 233 </p>
 234 <div class="variablelist"><table border="0">
 235 <col align="left" valign="top">
 236 <tbody>
 237 <tr>
 238 <td><p><span class="term"><em class="parameter"><code>wrapper</code></em> :</span></p></td>
 239 <td>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a>
 240 </td>
 241 </tr>
 242 <tr>
 243 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 244 <td>output stream</td>
 245 </tr>
 246 <tr>
 247 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 248 <td>the number of bytes written or <code class="literal">-1</code> on failure.</td>
 249 </tr>
 250 </tbody>
 251 </table></div>
 252 </div>
 253 </div>
 254 <div class="refsect1">
 255 <a name="GMimeDataWrapper.see-also"></a><h2>See Also</h2>
 256 <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a>
 257 </div>
 258 </div>
 259 <div class="footer">
 260 <hr>
 261           Generated by GTK-Doc V1.18</div>
 262 </body>
 263 </html>