libgmime-3.0-doc 3.2.0-1 / usr / share / gtk-doc / html / gmime-3.2 / GMimeStreamFile.html

This file is indexed.

/usr/share/gtk-doc/html/gmime-3.2/GMimeStreamFile.html is in libgmime-3.0-doc 3.2.0-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GMimeStreamFile: GMime 3.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GMime 3.0 Reference Manual">
<link rel="up" href="Streams.html" title="Streams">
<link rel="prev" href="GMimeStream.html" title="GMimeStream">
<link rel="next" href="GMimeStreamFs.html" title="GMimeStreamFs">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><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="#GMimeStreamFile.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GMimeStreamFile.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="Streams.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GMimeStream.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GMimeStreamFs.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GMimeStreamFile"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GMimeStreamFile.top_of_page"></a>GMimeStreamFile</span></h2>
<p>GMimeStreamFile — A Standard-C FILE-based stream</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GMimeStreamFile.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" 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="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
</td>
<td class="function_name">
<a class="link" href="GMimeStreamFile.html#g-mime-stream-file-new" title="g_mime_stream_file_new ()">g_mime_stream_file_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
</td>
<td class="function_name">
<a class="link" href="GMimeStreamFile.html#g-mime-stream-file-open" title="g_mime_stream_file_open ()">g_mime_stream_file_open</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
</td>
<td class="function_name">
<a class="link" href="GMimeStreamFile.html#g-mime-stream-file-new-with-bounds" title="g_mime_stream_file_new_with_bounds ()">g_mime_stream_file_new_with_bounds</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GMimeStreamFile.html#g-mime-stream-file-get-owner" title="g_mime_stream_file_get_owner ()">g_mime_stream_file_get_owner</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="GMimeStreamFile.html#g-mime-stream-file-set-owner" title="g_mime_stream_file_set_owner ()">g_mime_stream_file_set_owner</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GMimeStreamFile.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GMimeStreamFile.html#GMimeStreamFile-struct" title="struct GMimeStreamFile">GMimeStreamFile</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GMimeStreamFile.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> <a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a>
        <span class="lineart">╰──</span> GMimeStreamFile
</pre>
</div>
<div class="refsect1">
<a name="GMimeStreamFile.description"></a><h2>Description</h2>
<p>A simple <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> implementation that sits on top of the
Standard C FILE pointer based I/O layer. Unlike <a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a>, a
<a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> will typically buffer read and write operations at
the FILE level and so it may be wasteful to wrap one in a
<a class="link" href="GMimeStreamBuffer.html" title="GMimeStreamBuffer"><span class="type">GMimeStreamBuffer</span></a> stream.</p>
</div>
<div class="refsect1">
<a name="GMimeStreamFile.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="g-mime-stream-file-new"></a><h3>g_mime_stream_file_new ()</h3>
<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
g_mime_stream_file_new (<em class="parameter"><code><span class="type">FILE</span> *fp</code></em>);</pre>
<p>Creates a new <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> object around <em class="parameter"><code>fp</code></em>
.</p>
<p>Note: The created <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> object will own the FILE pointer
passed in.</p>
<div class="refsect3">
<a name="g-mime-stream-file-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>fp</p></td>
<td class="parameter_description"><p>a FILE pointer</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-stream-file-new.returns"></a><h4>Returns</h4>
<p> a stream using <em class="parameter"><code>fp</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-file-open"></a><h3>g_mime_stream_file_open ()</h3>
<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
g_mime_stream_file_open (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>,
                         <em class="parameter"><code>const <span class="type">char</span> *mode</code></em>,
                         <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
<p>Creates a new <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> object for the specified <em class="parameter"><code>path</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-stream-file-open.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>path</p></td>
<td class="parameter_description"><p>the path to a file</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>as in fopen(3)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>err</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-stream-file-open.returns"></a><h4>Returns</h4>
<p> a stream using for reading and/or writing to the
specified file path or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-file-new-with-bounds"></a><h3>g_mime_stream_file_new_with_bounds ()</h3>
<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
g_mime_stream_file_new_with_bounds (<em class="parameter"><code><span class="type">FILE</span> *fp</code></em>,
                                    <em class="parameter"><code><span class="type">gint64</span> start</code></em>,
                                    <em class="parameter"><code><span class="type">gint64</span> end</code></em>);</pre>
<p>Creates a new <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> object around <em class="parameter"><code>fp</code></em>
 with bounds <em class="parameter"><code>start</code></em>

and <em class="parameter"><code>end</code></em>
.</p>
<p>Note: The created <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> object will own the FILE pointer
passed in.</p>
<div class="refsect3">
<a name="g-mime-stream-file-new-with-bounds.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>fp</p></td>
<td class="parameter_description"><p>a FILE pointer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start</p></td>
<td class="parameter_description"><p>start boundary</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end</p></td>
<td class="parameter_description"><p>end boundary</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-stream-file-new-with-bounds.returns"></a><h4>Returns</h4>
<p> a stream using <em class="parameter"><code>fp</code></em>
with bounds <em class="parameter"><code>start</code></em>
and <em class="parameter"><code>end</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-file-get-owner"></a><h3>g_mime_stream_file_get_owner ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_stream_file_get_owner (<em class="parameter"><code><a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> *stream</code></em>);</pre>
<p>Gets whether or not <em class="parameter"><code>stream</code></em>
 owns the backend FILE pointer.</p>
<div class="refsect3">
<a name="g-mime-stream-file-get-owner.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>stream</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-stream-file-get-owner.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>stream</code></em>
owns the backend FILE pointer or <code class="literal">FALSE</code>
otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-file-set-owner"></a><h3>g_mime_stream_file_set_owner ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_stream_file_set_owner (<em class="parameter"><code><a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> *stream</code></em>,
                              <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>);</pre>
<p>Sets whether or not <em class="parameter"><code>stream</code></em>
 owns the backend FILE pointer.</p>
<p>Note: <em class="parameter"><code>owner</code></em>
 should be <code class="literal">TRUE</code> if the stream should <code class="function">fclose()</code> the
backend FILE pointer when destroyed or <code class="literal">FALSE</code> otherwise.</p>
<div class="refsect3">
<a name="g-mime-stream-file-set-owner.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>stream</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>owner</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if this stream should own the FILE pointer or <code class="literal">FALSE</code> otherwise</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GMimeStreamFile.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GMimeStreamFile-struct"></a><h3>struct GMimeStreamFile</h3>
<pre class="programlisting">struct GMimeStreamFile;</pre>
<p>A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> wrapper around standard-c FILE pointers.</p>
<div class="refsect3">
<a name="GMimeStreamFile.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GMimeStreamFile.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.