docs/reference/html/GMimeStreamFile.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>GMimeStreamFile</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="GMimeStream.html" title="GMimeStream">
  10 <link rel="next" href="GMimeStreamFs.html" title="GMimeStreamFs">
  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="GMimeStream.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="GMimeStreamFs.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="#GMimeStreamFile.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeStreamFile.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeStreamFile.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeStreamFile"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeStreamFile.top_of_page"></a>GMimeStreamFile</span></h2>
  36 <p>GMimeStreamFile — A Standard-C FILE-based stream</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeStreamFile.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GMimeStreamFile.html#GMimeStreamFile-struct" title="struct GMimeStreamFile">GMimeStreamFile</a>;
  43 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       <a class="link" href="GMimeStreamFile.html#g-mime-stream-file-new" title="g_mime_stream_file_new ()">g_mime_stream_file_new</a>              (<em class="parameter"><code><span class="type">FILE</span> *fp</code></em>);
  44 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       <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>  (<em class="parameter"><code><span class="type">FILE</span> *fp</code></em>,
  45                                                          <em class="parameter"><code><span class="type">gint64</span> start</code></em>,
  46                                                          <em class="parameter"><code><span class="type">gint64</span> end</code></em>);
  47 <span class="returnvalue">gboolean</span>            <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>        (<em class="parameter"><code><a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> *stream</code></em>);
  48 <span class="returnvalue">void</span>                <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>        (<em class="parameter"><code><a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> *stream</code></em>,
  49                                                          <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>);
  50 </pre>
  51 </div>
  52 <div class="refsect1">
  53 <a name="GMimeStreamFile.object-hierarchy"></a><h2>Object Hierarchy</h2>
  54 <pre class="synopsis">
  55   GObject
  56    +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a>
  57          +----GMimeStreamFile
  58 </pre>
  59 </div>
  60 <div class="refsect1">
  61 <a name="GMimeStreamFile.description"></a><h2>Description</h2>
  62 <p>
  63 A simple <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> implementation that sits on top of the
  64 Standard C FILE pointer based I/O layer. Unlike <a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a>, a
  65 <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> will typically buffer read and write operations at
  66 the FILE level and so it may be wasteful to wrap one in a
  67 <a class="link" href="GMimeStreamBuffer.html" title="GMimeStreamBuffer"><span class="type">GMimeStreamBuffer</span></a> stream.
  68 </p>
  69 </div>
  70 <div class="refsect1">
  71 <a name="GMimeStreamFile.details"></a><h2>Details</h2>
  72 <div class="refsect2">
  73 <a name="GMimeStreamFile-struct"></a><h3>struct GMimeStreamFile</h3>
  74 <pre class="programlisting">struct GMimeStreamFile;</pre>
  75 <p>
  76 A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> wrapper around standard-c FILE pointers.
  77 </p>
  78 <div class="variablelist"><table border="0">
  79 <col align="left" valign="top">
  80 <tbody></tbody>
  81 </table></div>
  82 </div>
  83 <hr>
  84 <div class="refsect2">
  85 <a name="g-mime-stream-file-new"></a><h3>g_mime_stream_file_new ()</h3>
  86 <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>
  87 <p>
  88 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>.
  89 </p>
  90 <p>
  91 Note: The created <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> object will own the FILE pointer
  92 passed in.
  93 </p>
  94 <div class="variablelist"><table border="0">
  95 <col align="left" valign="top">
  96 <tbody>
  97 <tr>
  98 <td><p><span class="term"><em class="parameter"><code>fp</code></em> :</span></p></td>
  99 <td>a FILE pointer</td>
 100 </tr>
 101 <tr>
 102 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 103 <td>a stream using <em class="parameter"><code>fp</code></em>.</td>
 104 </tr>
 105 </tbody>
 106 </table></div>
 107 </div>
 108 <hr>
 109 <div class="refsect2">
 110 <a name="g-mime-stream-file-new-with-bounds"></a><h3>g_mime_stream_file_new_with_bounds ()</h3>
 111 <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>,
 112                                                          <em class="parameter"><code><span class="type">gint64</span> start</code></em>,
 113                                                          <em class="parameter"><code><span class="type">gint64</span> end</code></em>);</pre>
 114 <p>
 115 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>
 116 and <em class="parameter"><code>end</code></em>.
 117 </p>
 118 <p>
 119 Note: The created <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> object will own the FILE pointer
 120 passed in.
 121 </p>
 122 <div class="variablelist"><table border="0">
 123 <col align="left" valign="top">
 124 <tbody>
 125 <tr>
 126 <td><p><span class="term"><em class="parameter"><code>fp</code></em> :</span></p></td>
 127 <td>a FILE pointer</td>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td>
 131 <td>start boundary</td>
 132 </tr>
 133 <tr>
 134 <td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td>
 135 <td>end boundary</td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 139 <td>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>.</td>
 140 </tr>
 141 </tbody>
 142 </table></div>
 143 </div>
 144 <hr>
 145 <div class="refsect2">
 146 <a name="g-mime-stream-file-get-owner"></a><h3>g_mime_stream_file_get_owner ()</h3>
 147 <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>
 148 <p>
 149 Gets whether or not <em class="parameter"><code>stream</code></em> owns the backend FILE pointer.
 150 </p>
 151 <div class="variablelist"><table border="0">
 152 <col align="left" valign="top">
 153 <tbody>
 154 <tr>
 155 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 156 <td>a <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a>
 157 </td>
 158 </tr>
 159 <tr>
 160 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 161 <td>
 162 <code class="literal">TRUE</code> if <em class="parameter"><code>stream</code></em> owns the backend FILE pointer or <code class="literal">FALSE</code>
 163 otherwise.</td>
 164 </tr>
 165 </tbody>
 166 </table></div>
 167 </div>
 168 <hr>
 169 <div class="refsect2">
 170 <a name="g-mime-stream-file-set-owner"></a><h3>g_mime_stream_file_set_owner ()</h3>
 171 <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>,
 172                                                          <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>);</pre>
 173 <p>
 174 Sets whether or not <em class="parameter"><code>stream</code></em> owns the backend FILE pointer.
 175 </p>
 176 <p>
 177 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
 178 backend FILE pointer when destroyed or <code class="literal">FALSE</code> otherwise.
 179 </p>
 180 <div class="variablelist"><table border="0">
 181 <col align="left" valign="top">
 182 <tbody>
 183 <tr>
 184 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 185 <td>a <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a>
 186 </td>
 187 </tr>
 188 <tr>
 189 <td><p><span class="term"><em class="parameter"><code>owner</code></em> :</span></p></td>
 190 <td>
 191 <code class="literal">TRUE</code> if this stream should own the FILE pointer or <code class="literal">FALSE</code> otherwise</td>
 192 </tr>
 193 </tbody>
 194 </table></div>
 195 </div>
 196 </div>
 197 <div class="refsect1">
 198 <a name="GMimeStreamFile.see-also"></a><h2>See Also</h2>
 199 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a>
 200 </div>
 201 </div>
 202 <div class="footer">
 203 <hr>
 204           Generated by GTK-Doc V1.18</div>
 205 </body>
 206 </html>