docs/reference/html/GMimeStreamMem.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>GMimeStreamMem</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="Streams.html" title="Streams">
   9 <link rel="prev" href="GMimeStreamFs.html" title="GMimeStreamFs">
  10 <link rel="next" href="GMimeStreamMmap.html" title="GMimeStreamMmap">
  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="GMimeStreamFs.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="Streams.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="GMimeStreamMmap.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="#GMimeStreamMem.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeStreamMem.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeStreamMem.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeStreamMem"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeStreamMem.top_of_page"></a>GMimeStreamMem</span></h2>
  36 <p>GMimeStreamMem — A memory-backed stream</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeStreamMem.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GMimeStreamMem.html#GMimeStreamMem-struct" title="struct GMimeStreamMem">GMimeStreamMem</a>;
  43 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-new" title="g_mime_stream_mem_new ()">g_mime_stream_mem_new</a>               (<em class="parameter"><code><span class="type">void</span></code></em>);
  44 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-new-with-byte-array" title="g_mime_stream_mem_new_with_byte_array ()">g_mime_stream_mem_new_with_byte_array</a>
  45                                                         (<em class="parameter"><code><span class="type">GByteArray</span> *array</code></em>);
  46 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-new-with-buffer" title="g_mime_stream_mem_new_with_buffer ()">g_mime_stream_mem_new_with_buffer</a>   (<em class="parameter"><code>const <span class="type">char</span> *buffer</code></em>,
  47                                                          <em class="parameter"><code><span class="type">size_t</span> len</code></em>);
  48 <span class="returnvalue">GByteArray</span> *        <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-get-byte-array" title="g_mime_stream_mem_get_byte_array ()">g_mime_stream_mem_get_byte_array</a>    (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>);
  49 <span class="returnvalue">void</span>                <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-set-byte-array" title="g_mime_stream_mem_set_byte_array ()">g_mime_stream_mem_set_byte_array</a>    (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>,
  50                                                          <em class="parameter"><code><span class="type">GByteArray</span> *array</code></em>);
  51 <span class="returnvalue">gboolean</span>            <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-get-owner" title="g_mime_stream_mem_get_owner ()">g_mime_stream_mem_get_owner</a>         (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>);
  52 <span class="returnvalue">void</span>                <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-set-owner" title="g_mime_stream_mem_set_owner ()">g_mime_stream_mem_set_owner</a>         (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>,
  53                                                          <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>);
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="GMimeStreamMem.object-hierarchy"></a><h2>Object Hierarchy</h2>
  58 <pre class="synopsis">
  59   GObject
  60    +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a>
  61          +----GMimeStreamMem
  62 </pre>
  63 </div>
  64 <div class="refsect1">
  65 <a name="GMimeStreamMem.description"></a><h2>Description</h2>
  66 <p>
  67 A simple <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> implementation that uses a memory buffer for
  68 storage.
  69 </p>
  70 </div>
  71 <div class="refsect1">
  72 <a name="GMimeStreamMem.details"></a><h2>Details</h2>
  73 <div class="refsect2">
  74 <a name="GMimeStreamMem-struct"></a><h3>struct GMimeStreamMem</h3>
  75 <pre class="programlisting">struct GMimeStreamMem;</pre>
  76 <p>
  77 A memory-backed <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a>.
  78 </p>
  79 <div class="variablelist"><table border="0">
  80 <col align="left" valign="top">
  81 <tbody></tbody>
  82 </table></div>
  83 </div>
  84 <hr>
  85 <div class="refsect2">
  86 <a name="g-mime-stream-mem-new"></a><h3>g_mime_stream_mem_new ()</h3>
  87 <pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       g_mime_stream_mem_new               (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
  88 <p>
  89 Creates a new <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> object.
  90 </p>
  91 <div class="variablelist"><table border="0">
  92 <col align="left" valign="top">
  93 <tbody><tr>
  94 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  95 <td>a new memory stream.</td>
  96 </tr></tbody>
  97 </table></div>
  98 </div>
  99 <hr>
 100 <div class="refsect2">
 101 <a name="g-mime-stream-mem-new-with-byte-array"></a><h3>g_mime_stream_mem_new_with_byte_array ()</h3>
 102 <pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       g_mime_stream_mem_new_with_byte_array
 103                                                         (<em class="parameter"><code><span class="type">GByteArray</span> *array</code></em>);</pre>
 104 <p>
 105 Creates a new <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> with data <em class="parameter"><code>array</code></em>.
 106 </p>
 107 <div class="variablelist"><table border="0">
 108 <col align="left" valign="top">
 109 <tbody>
 110 <tr>
 111 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
 112 <td>source data</td>
 113 </tr>
 114 <tr>
 115 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 116 <td>a new memory stream using <em class="parameter"><code>array</code></em>.</td>
 117 </tr>
 118 </tbody>
 119 </table></div>
 120 </div>
 121 <hr>
 122 <div class="refsect2">
 123 <a name="g-mime-stream-mem-new-with-buffer"></a><h3>g_mime_stream_mem_new_with_buffer ()</h3>
 124 <pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       g_mime_stream_mem_new_with_buffer   (<em class="parameter"><code>const <span class="type">char</span> *buffer</code></em>,
 125                                                          <em class="parameter"><code><span class="type">size_t</span> len</code></em>);</pre>
 126 <p>
 127 Creates a new <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> object and initializes the stream
 128 contents with the first <em class="parameter"><code>len</code></em> bytes of <em class="parameter"><code>buffer</code></em>.
 129 </p>
 130 <div class="variablelist"><table border="0">
 131 <col align="left" valign="top">
 132 <tbody>
 133 <tr>
 134 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
 135 <td>stream data</td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
 139 <td>buffer length</td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 143 <td>a new memory stream initialized with <em class="parameter"><code>buffer</code></em>.</td>
 144 </tr>
 145 </tbody>
 146 </table></div>
 147 </div>
 148 <hr>
 149 <div class="refsect2">
 150 <a name="g-mime-stream-mem-get-byte-array"></a><h3>g_mime_stream_mem_get_byte_array ()</h3>
 151 <pre class="programlisting"><span class="returnvalue">GByteArray</span> *        g_mime_stream_mem_get_byte_array    (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>);</pre>
 152 <p>
 153 Gets the byte array from the memory stream.
 154 </p>
 155 <div class="variablelist"><table border="0">
 156 <col align="left" valign="top">
 157 <tbody>
 158 <tr>
 159 <td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td>
 160 <td>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a>
 161 </td>
 162 </tr>
 163 <tr>
 164 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 165 <td>the byte array from the memory stream.</td>
 166 </tr>
 167 </tbody>
 168 </table></div>
 169 </div>
 170 <hr>
 171 <div class="refsect2">
 172 <a name="g-mime-stream-mem-set-byte-array"></a><h3>g_mime_stream_mem_set_byte_array ()</h3>
 173 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_stream_mem_set_byte_array    (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>,
 174                                                          <em class="parameter"><code><span class="type">GByteArray</span> *array</code></em>);</pre>
 175 <p>
 176 Sets the byte array on the memory stream.
 177 </p>
 178 <p>
 179 Note: The memory stream is not responsible for freeing the byte
 180 array. Use <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-set-owner" title="g_mime_stream_mem_set_owner ()"><code class="function">g_mime_stream_mem_set_owner()</code></a> to change this behavior.
 181 </p>
 182 <div class="variablelist"><table border="0">
 183 <col align="left" valign="top">
 184 <tbody>
 185 <tr>
 186 <td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td>
 187 <td>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a>
 188 </td>
 189 </tr>
 190 <tr>
 191 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
 192 <td>stream data</td>
 193 </tr>
 194 </tbody>
 195 </table></div>
 196 </div>
 197 <hr>
 198 <div class="refsect2">
 199 <a name="g-mime-stream-mem-get-owner"></a><h3>g_mime_stream_mem_get_owner ()</h3>
 200 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_stream_mem_get_owner         (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>);</pre>
 201 <p>
 202 Gets whether or not <em class="parameter"><code>mem</code></em> owns the backend memory buffer.
 203 </p>
 204 <div class="variablelist"><table border="0">
 205 <col align="left" valign="top">
 206 <tbody>
 207 <tr>
 208 <td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td>
 209 <td>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a>
 210 </td>
 211 </tr>
 212 <tr>
 213 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 214 <td>
 215 <code class="literal">TRUE</code> if <em class="parameter"><code>mem</code></em> owns the backend memory buffer or <code class="literal">FALSE</code>
 216 otherwise.</td>
 217 </tr>
 218 </tbody>
 219 </table></div>
 220 </div>
 221 <hr>
 222 <div class="refsect2">
 223 <a name="g-mime-stream-mem-set-owner"></a><h3>g_mime_stream_mem_set_owner ()</h3>
 224 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_stream_mem_set_owner         (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>,
 225                                                          <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>);</pre>
 226 <p>
 227 Sets whether or not <em class="parameter"><code>mem</code></em> owns the backend memory buffer.
 228 </p>
 229 <p>
 230 Note: <em class="parameter"><code>owner</code></em> should be <code class="literal">TRUE</code> if the stream should free the backend
 231 memory buffer when destroyed or <code class="literal">FALSE</code> otherwise.
 232 </p>
 233 <div class="variablelist"><table border="0">
 234 <col align="left" valign="top">
 235 <tbody>
 236 <tr>
 237 <td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td>
 238 <td>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a>
 239 </td>
 240 </tr>
 241 <tr>
 242 <td><p><span class="term"><em class="parameter"><code>owner</code></em> :</span></p></td>
 243 <td>
 244 <code class="literal">TRUE</code> if this stream should own the <span class="type">GByteArray</span> or <code class="literal">FALSE</code> otherwise</td>
 245 </tr>
 246 </tbody>
 247 </table></div>
 248 </div>
 249 </div>
 250 <div class="refsect1">
 251 <a name="GMimeStreamMem.see-also"></a><h2>See Also</h2>
 252 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a>
 253 </div>
 254 </div>
 255 <div class="footer">
 256 <hr>
 257           Generated by GTK-Doc V1.18</div>
 258 </body>
 259 </html>