blob: f82ca0dbca258760c5b5de34e083b3ed85c726b5 (
plain)
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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GMimeStreamMem</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GMime 2.6 Reference Manual">
<link rel="up" href="Streams.html" title="Streams">
<link rel="prev" href="GMimeStreamFs.html" title="GMimeStreamFs">
<link rel="next" href="GMimeStreamMmap.html" title="GMimeStreamMmap">
<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="GMimeStreamFs.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Streams.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">GMime 2.6 Reference Manual</th>
<td><a accesskey="n" href="GMimeStreamMmap.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GMimeStreamMem.synopsis" class="shortcut">Top</a>
|
<a href="#GMimeStreamMem.description" class="shortcut">Description</a>
|
<a href="#GMimeStreamMem.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="GMimeStreamMem"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GMimeStreamMem.top_of_page"></a>GMimeStreamMem</span></h2>
<p>GMimeStreamMem — A memory-backed stream</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GMimeStreamMem.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="GMimeStreamMem.html#GMimeStreamMem-struct" title="struct GMimeStreamMem">GMimeStreamMem</a>;
<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>);
<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>
(<em class="parameter"><code><span class="type">GByteArray</span> *array</code></em>);
<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>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>);
<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>);
<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>,
<em class="parameter"><code><span class="type">GByteArray</span> *array</code></em>);
<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>);
<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>,
<em class="parameter"><code><span class="type">gboolean</span> owner</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GMimeStreamMem.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a>
+----GMimeStreamMem
</pre>
</div>
<div class="refsect1">
<a name="GMimeStreamMem.description"></a><h2>Description</h2>
<p>
A simple <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> implementation that uses a memory buffer for
storage.
</p>
</div>
<div class="refsect1">
<a name="GMimeStreamMem.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GMimeStreamMem-struct"></a><h3>struct GMimeStreamMem</h3>
<pre class="programlisting">struct GMimeStreamMem;</pre>
<p>
A memory-backed <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-mem-new"></a><h3>g_mime_stream_mem_new ()</h3>
<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>
<p>
Creates a new <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new memory stream.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-mem-new-with-byte-array"></a><h3>g_mime_stream_mem_new_with_byte_array ()</h3>
<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
(<em class="parameter"><code><span class="type">GByteArray</span> *array</code></em>);</pre>
<p>
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>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
<td>source data</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new memory stream using <em class="parameter"><code>array</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-mem-new-with-buffer"></a><h3>g_mime_stream_mem_new_with_buffer ()</h3>
<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>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>);</pre>
<p>
Creates a new <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> object and initializes the stream
contents with the first <em class="parameter"><code>len</code></em> bytes of <em class="parameter"><code>buffer</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>buffer</code></em> :</span></p></td>
<td>stream data. <span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=len][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> guint8]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
<td>buffer length</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new memory stream initialized with <em class="parameter"><code>buffer</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-mem-get-byte-array"></a><h3>g_mime_stream_mem_get_byte_array ()</h3>
<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>
<p>
Gets the byte array from the memory stream.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the byte array from the memory stream. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-mem-set-byte-array"></a><h3>g_mime_stream_mem_set_byte_array ()</h3>
<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>,
<em class="parameter"><code><span class="type">GByteArray</span> *array</code></em>);</pre>
<p>
Sets the byte array on the memory stream.
</p>
<p>
Note: The memory stream is not responsible for freeing the byte
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
<td>stream data</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-mem-get-owner"></a><h3>g_mime_stream_mem_get_owner ()</h3>
<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>
<p>
Gets whether or not <em class="parameter"><code>mem</code></em> owns the backend memory buffer.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if <em class="parameter"><code>mem</code></em> owns the backend memory buffer or <code class="literal">FALSE</code>
otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-mem-set-owner"></a><h3>g_mime_stream_mem_set_owner ()</h3>
<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>,
<em class="parameter"><code><span class="type">gboolean</span> owner</code></em>);</pre>
<p>
Sets whether or not <em class="parameter"><code>mem</code></em> owns the backend memory buffer.
</p>
<p>
Note: <em class="parameter"><code>owner</code></em> should be <code class="literal">TRUE</code> if the stream should free the backend
memory buffer when destroyed or <code class="literal">FALSE</code> otherwise.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>owner</code></em> :</span></p></td>
<td>
<code class="literal">TRUE</code> if this stream should own the <span class="type">GByteArray</span> or <code class="literal">FALSE</code> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GMimeStreamMem.see-also"></a><h2>See Also</h2>
<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|
